47 lines
2.5 KiB
Markdown
47 lines
2.5 KiB
Markdown
# conti-docs
|
||
|
||
Continental Retail APP 相关的文档参考仓库，用于沉淀架构决策、系统/网络架构图，以及后续会陆续补充的后端设计和 API 文档。
|
||
|
||
## 目录说明
|
||
|
||
### App 架构决策文档
|
||
|
||
Flutter APP 的分包、分层、技术选型等决策记录，按序号阅读：
|
||
|
||
| 文档 | 内容 |
|
||
| --- | --- |
|
||
| [01-project-structure.md](./01-project-structure.md) | 工程结构 / 分包策略（Melos monorepo） |
|
||
| [02-layering.md](./02-layering.md) | 分层架构规范（presentation/domain/data） |
|
||
| [03-state-management.md](./03-state-management.md) | 状态管理方案（Riverpod） |
|
||
| [04-routing.md](./04-routing.md) | 路由方案（go_router） |
|
||
| [05-networking.md](./05-networking.md) | 网络层设计（dio） |
|
||
| [06-local-storage.md](./06-local-storage.md) | 本地存储方案（Drift / secure storage / shared_preferences） |
|
||
| [07-native-integration.md](./07-native-integration.md) | 原生能力集成方式（Pigeon） |
|
||
| [08-build-flavors.md](./08-build-flavors.md) | 多环境构建（dev/uat/prod flavor） |
|
||
| [09-testing.md](./09-testing.md) | 测试策略（单元/Widget/集成测试） |
|
||
|
||
### Architecture-Diagram/
|
||
|
||
前期系统架构、网络架构梳理阶段产出的图和说明文档，先保留作为历史参考，后续可能会做精简：
|
||
|
||
- `architecture-diagram.drawio` / `architecture-diagram-explanation.md` — 系统架构图（System Overview / System Architecture / Key Flows）及说明
|
||
- `network-architecture-diagram.drawio` / `network-architecture-explanation.md` — 多云网络架构图（业务域边界、VNet/VPC 拓扑）及说明
|
||
- `app-architecture-diagram.drawio` — APP 侧架构图
|
||
- `deployment-architecture-diagram.drawio` / `system-architecture-diagram.drawio` — 部署架构图 / 系统架构图
|
||
- `gitlab-cicd-azure-deployment-diagram.drawio` — GitLab CI/CD 到 Azure 的部署流程图
|
||
- `202606-Continental-Retail-APP-PRD.md` — 产品需求文档（PRD）
|
||
- `202606-Conti-Retail-APP-Component-data-source.md` — 功能模块与数据来源整理
|
||
- `零售商系统方案研讨会PPT.retro.md` — 方案研讨会复盘记录
|
||
- `extract_requirements_to_md.py` / `extract_component_data_to_md.py` — 从原始材料提取内容生成上述 md 文档的脚本
|
||
|
||
`.drawio` 文件可用 [draw.io 桌面版](https://github.com/jgraph/drawio-desktop) 或 VS Code 的 Draw.io Integration 插件打开查看。
|
||
|
||
## 待补充
|
||
|
||
- Backend 设计文档
|
||
- API 文档
|
||
|
||
## 语言约定
|
||
|
||
文档以中文为主。
|