john
1aaef71f52
Document-driven MVP with FastAPI backend, Vue H5, WeChat mini shell, product demo, and Docker dev stack. Co-authored-by: Cursor <cursoragent@cursor.com>
43 lines
999 B
Markdown
43 lines
999 B
Markdown
# happy-up API
|
|
|
|
基于 `contracts/openapi.yaml` 的 FastAPI 工程。**Sprint 3** 完成训练计划/打卡 + Admin 看板落库，OpenAPI 契约模块已全部对接 DB。
|
|
|
|
## 快速启动
|
|
|
|
```bash
|
|
cd ../.. && make up
|
|
cd apps/api && source .venv/bin/activate
|
|
pip install -e ".[dev]"
|
|
cp .env.example .env
|
|
make api-seed
|
|
make api-dev
|
|
```
|
|
|
|
## 模块状态（全部落库）
|
|
|
|
| 模块 | 端点 |
|
|
|------|------|
|
|
| Auth + Children | `/api/auth/*` `/api/children/*` |
|
|
| Videos + Analysis + Reports | `/api/videos/*` `/api/analysis/*` `/api/reports/*` |
|
|
| Training | `/api/training/plans*` |
|
|
| Admin | `/api/admin/dashboard` |
|
|
|
|
## Demo 全链路联调
|
|
|
|
1. `make api-dev`
|
|
2. 打开 `产品交互Demo.html` → **API 联调开**
|
|
3. 家长端：登录 → 筛查 → 报告 → **训练计划** → 跟练 → **打卡写入**
|
|
4. 管理后台：运营看板 KPI 来自真实 DB 聚合
|
|
|
|
## 测试
|
|
|
|
```bash
|
|
make api-test # 9 用例
|
|
```
|
|
|
|
## Worker
|
|
|
|
```bash
|
|
make api-worker # 分析任务 Redis 消费者
|
|
```
|