milmilmilmil
貢獻指南

開發環境設定

設定 milmil 嘅本機開發環境。

前置條件

  • Go 1.27+ — 後端 API
  • Bun 1.3+ — 前端建置工具
  • FFmpeg — 媒體處理
  • Docker — 用於 PostgreSQL 同 Redis（或者喺本機安裝）

開始開發

複製儲存庫

git clone https://github.com/milmil-dev/milmil.git
cd milmil

啟動基礎設施

docker compose -f docker-compose.dev.yml up -d

呢個會啟動開發用嘅 PostgreSQL 同 Redis。

啟動後端

cd api
cp .env.example .env
go mod download
make dev

API 伺服器會喺 http://localhost:8080 啟動，支援熱重載。

啟動前端

cd web
bun install
bun run dev

開發伺服器會喺 http://localhost:5173 啟動，支援 HMR。

儲存庫結構

go.mod
Makefile
package.json
docker-compose.yml
Makefile

Pull Request 指引

  1. Fork 儲存庫並建立功能分支
  2. 為新功能撰寫測試
  3. 確保 make lint 同 make test 通過
  4. 保持 PR 專注 — 每個 PR 只處理一個功能或修正
  5. 撰寫清晰嘅提交訊息描述變更內容

參與貢獻

點樣為 milmil 作出貢獻。

回報問題

點樣回報 bug 同提出功能請求。

本頁內容

前置條件開始開發複製儲存庫啟動基礎設施啟動後端啟動前端儲存庫結構Pull Request 指引