一個完整的專案不只是程式碼,還要讓其他人知道它是做什麼的,以及如何在自己的電腦執行。
步驟 1:建立 README.md
在專案根目錄建立 README.md,填入以下內容:
一個使用 Python、Flask 與 SQLite 製作的個人電影及遊戲收藏管理網站。
將專案下載或複製到本機,並在終端機進入專案目錄。
Windows:
python -m venv .venv
.venv\Scripts\activate
macOS / Linux:
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -r requirements.txt
python database.py
python app.py
在瀏覽器開啟:
app.py:網站路由與功能database.py:SQLite 連線與資料表初始化templates/:HTML 模板static/:CSS 與靜態資源media.db:收藏資料庫(執行後產生)本專案為學習用途,預設在本機開發環境執行。
正式公開部署前,應補上 CSRF 防護、
更完整的輸入驗證及正式環境設定。
步驟 2:檢查 requirements.txt
在虛擬環境啟動的狀態下執行:
python -m pip freeze
將實際需要的套件及版本整理到 requirements.txt。之後其他人就能用:
python -m pip install -r requirements.txt
安裝專案依賴。
步驟 3:確認專案不依賴測試資料檔
確認網站不會因為缺少 seed.py 或 check_db.py 而無法啟動。
media.db 如果是個人收藏資料,應該視為使用者資料,不要隨意公開。若打算將專案放到 GitHub,可以在 .gitignore 加入:
.venv/
pycache/
.pytest_cache/
media.db
.env