昨天Review完Readme後,今天要來Code review,首先來看專案結構,
README.MD
和 db_Architecture.png,但當專案中的文件增多時,需要一個專門的資料夾。src/ 下可以新增不同目錄:
src/
controllers/ # 處理API interface
services/ # 處理API邏輯
models/ # 資料模型和資料庫相關的操作
utils/ # 用共的方法,例如db_util和log_init
config/ # 存放config
config.json 建議放在一個 config/ 目錄中。建議使用 .yml 或 .env 格式作為config。
data_init.py 是資料庫初始化及資料ETL的腳本,應該放在scripts/ 或 migrations/ 目錄下。
可以建立一個 logs/ 目錄來存放日誌文件和相關設定。
可以在 data/ 目錄下創建一個 README.md 或 INFO.txt,描述資料的格式。
建立一個 tests/ 目錄存放Unit test。
增加 Dockerfile 和 docker-compose.yml (如果需要的話)。可以使想要執行這個專案的人可以更容易地在容器化環境中執行。
增加一個docs/ 或 assets/ 目錄,將相關的文件和圖片資源集中存放,也可以將postman collection放在這邊。
在學習新語言或框架時,我會先去看該語言或框架的best practice(Cookiecutter Templates),看他們怎麼設計目錄結構,怎麼去歸類程式碼和腳本和其他文件,一方面可以增加對語言框架的熟悉度,另一方面在研究別人的專案時比較快上手。