- /data:存放原始資料,例如
.csv
- /outputs:產生的檔案,包含圖檔、快取、中介格式的
.json
等 - /src/crawlers:爬取資料公開平台上的資料的爬蟲
- /src/parsers:解析和清理原始資料的解析器
yarn tsc
執行之前必須把 config.example.toml
複製到 config.toml
並填入對應的設定值
需要編譯之後才能執行
yarn start {file_path}
範例
# execute ./index.js
yarn start .
此專案採用 Airbnb 風格,並使用 VS Code 外掛 Prettier ESLint (Pre-Release) 自動排版。
程式碼,包含註解,請以英文撰寫,Git 的 commit 風格請遵守 Tim Pope 使用的規範。標題限制 50 字元,標題與內文間空一行,內文每行最多 72 字元,特長變數名稱和網址等可例外。
例外:
this_is_a_super_looooooooooooooooooooooooooooooooooooooooooooooooooooooooong_variable
https://our.subdomain.contains.a.lot.of.words.and.exceeds.seventy.two.characters.fmra.org/
請在 Git commit 訊息中標註 issue 編號,格式見 GitHub 官方文件。
目前暫時不需要 pull request,直接在 main
分支上開發,然後 push 上去即可。
- 使用 Git hook 檢查 commit 訊息和程式碼格式
- 設計 SQL schema 並暫時使用 sqlite 做資料庫
- 前端報表
- docker compose 打包開發與部屬環境
- 部屬到 AWS 或 Azure