提供花蓮光復地區救災相關資訊的後端 API 服務
| 項目 | 說明 | 連結 |
|---|---|---|
| 🌐 | 官網 | gf250923.org |
| 🎨 | UI 設計稿 | Figma |
| 📚 | API 規格 | table_spec.md |
| 📊 | 資料來源 | Google Sheet 副本 |
| 技術層 | 使用技術 |
|---|---|
| 前端 | React |
| 後端 | FastAPI |
| 資料庫 | PostgreSQL |
| ORM | SQLAlchemy |
| 遷移工具 | Alembic |
cd guanfu_backend
# 1. 複製環境變數檔案
cp .env.example .env.dev
# 2. 啟動所有服務(資料庫 + 後端)
docker compose --env-file .env.dev up -d --build
# 3. 查看 API 文件
# 訪問 http://localhost:8080/docscd guanfu_backend
# 1. 安裝 uv 套件管理工具
brew install uv
# 2. 設定 Python 環境
uv python install 3.13
uv sync
# 3. 只啟動資料庫
docker compose --env-file .env.dev up -d postgres
# 4. 啟動開發伺服器
uv run uvicorn src.main:app --reload --port 8080📖 詳細說明請參考:開發環境設定指南
| 文件 | 說明 |
|---|---|
| 🚀 開發環境設定 | 從零開始設定開發環境(Docker / 本地開發) |
| 🔄 Alembic 遷移指南 | 資料庫結構變更與遷移操作 |
| 📊 API 規格 | 完整的 API 端點與資料表規格 |
| 🔀 Git Flow 圖示 | 專案的 Git 工作流程 |
| 🖥️ 部署指南 | 部署到 Compute Engine 的步驟 |
| 🤝 貢獻指南 | 如何參與專案開發 |
感謝所有參與花蓮光復救災工作的志工與開發者們!
Made with ❤️ for 花蓮光復