54 lines
1.5 KiB
Markdown
54 lines
1.5 KiB
Markdown
# NeoZQYY Monorepo
|
||
|
||
台球门店运营助手一体化平台，整合 ETL 数据管线、微信小程序后端、小程序前端、管理后台与桌面 GUI。
|
||
|
||
## 项目结构
|
||
|
||
| 目录 | 说明 |
|
||
|------|------|
|
||
| apps/etl/pipelines/feiqiu/ | ETL 数据管线（飞球平台） |
|
||
| apps/backend/ | FastAPI 后端（小程序 API） |
|
||
| apps/miniprogram/ | 微信小程序（Donut + TDesign） |
|
||
| apps/admin-web/ | 管理后台（规划中） |
|
||
| gui/ | PySide6 桌面 GUI（过渡期） |
|
||
| packages/shared/ | 跨项目共享包（枚举、金额精度、时间工具） |
|
||
| db/ | 数据库 DDL、迁移、种子脚本 |
|
||
| docs/ | 文档（PRD、契约、权限矩阵、架构等） |
|
||
| infra/ | 基础设施配置 |
|
||
| scripts/ | 运维/工具脚本 |
|
||
| samples/ | 示例数据与配置 |
|
||
| tests/ | Monorepo 级属性测试 |
|
||
|
||
## 快速开始
|
||
|
||
```bash
|
||
# 安装全部依赖（需要 uv）
|
||
uv sync
|
||
|
||
# 运行 ETL
|
||
cd apps/etl/pipelines/feiqiu
|
||
python -m cli.main --pg-dsn "$PG_DSN" --store-id "$STORE_ID" --api-token "$API_TOKEN"
|
||
|
||
# 启动后端 API
|
||
cd apps/backend
|
||
uvicorn app.main:app --reload
|
||
|
||
# 运行 ETL 单元测试
|
||
cd apps/etl/pipelines/feiqiu
|
||
pytest tests/unit
|
||
```
|
||
|
||
## 配置
|
||
|
||
配置采用分层叠加：根 .env -> 应用 .env.local -> 环境变量 -> CLI 参数。
|
||
|
||
参见 .env.template 了解可用配置项。
|
||
|
||
## 技术栈
|
||
|
||
- Python 3.10+, uv workspace
|
||
- PostgreSQL（六层 Schema：meta/ods/dwd/core/dws/app）
|
||
- FastAPI + uvicorn
|
||
- PySide6（桌面 GUI）
|
||
- Donut + TDesign（微信小程序）
|