80 lines
3.6 KiB
Markdown
80 lines
3.6 KiB
Markdown
<!-- gitea-wiki-mirror:start -->
|
||
generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件)
|
||
wiki_page: Home
|
||
wiki_url: https://git.ilapage.cn/OPC/cmautobuy/wiki/Home
|
||
wiki_revision: d3e7d43c3ba0868ba4d7deb801f6bce87c41caa9
|
||
synchronized_at: 2026-08-26T09:11:13Z
|
||
<!-- gitea-wiki-mirror:end -->
|
||
|
||
# cmautobuy 文档首页
|
||
|
||
cmautobuy 由两个交付单元组成：Admin 是 Go Web 管理端，Client 是 Windows + Android 自动化执行端。两个子项目技术栈不同，但通过 Client 侧 API 契约协作。
|
||
|
||
## 第一次阅读
|
||
|
||
- 第一次接手项目：先读 [项目档案](Project-Profile) 和对应子项目上手指南。
|
||
- 修改 Admin：先读仓库 `admin/AGENTS.md`，再按任务进入 [Admin 上手指南](Admin-Getting-Started)。
|
||
- 修改 Client：先读仓库 `client/AGENTS.md`，再按任务进入 [Client 上手指南](Client-Getting-Started)。
|
||
- 修改两边接口：以 [Client–Admin API 契约](Client-Admin-API-Contract) 为唯一事实来源。
|
||
- 了解完整业务目标：读 [产品需求总览](Product-Requirements-Overview)。
|
||
|
||
## 五分钟开始
|
||
|
||
从仓库根目录执行：
|
||
|
||
```powershell
|
||
git status --short
|
||
python dev_scripts/harness.py check --strict
|
||
```
|
||
|
||
Admin 的常用验证从 `admin/` 执行：
|
||
|
||
```powershell
|
||
$env:GOTOOLCHAIN="go1.23.0"
|
||
go build ./...
|
||
go test ./... -count=1
|
||
Remove-Item Env:GOTOOLCHAIN
|
||
```
|
||
|
||
Client 的普通离线验证从 `client/` 执行；不要把真实采购当冒烟测试：
|
||
|
||
```powershell
|
||
C:/Python310/python.exe -m unittest discover -s test -v
|
||
```
|
||
|
||
## 简单修改从哪里开始
|
||
|
||
| 要做的事 | 先读 |
|
||
|---|---|
|
||
| 找代码入口和调用边界 | [架构与代码地图](Architecture-and-Code-Map) |
|
||
| 查业务术语和红线 | [业务规则与术语](Business-Rules-and-Glossary) |
|
||
| 本地启动和验证 | [本地开发与验证](Local-Development-and-Verification) |
|
||
| 常见改动的最小路径 | [常见修改](Common-Changes) |
|
||
| 分析报错 | [故障排查](Troubleshooting) |
|
||
| 建工单、实施、验收 | [开发工作流](Development-Workflow) |
|
||
| 写面向采购员或运维的文档 | [交付文档指南](Delivery-Documentation-Guide) |
|
||
| 部署或回退 Admin | [Admin 部署与运维](Deployment-and-Operations) |
|
||
|
||
## 详细文档
|
||
|
||
Admin 与 Client 的详细长期文档已经迁移为 Wiki 页面：
|
||
|
||
- Client：[上手](Client-Getting-Started) · [术语](Client-Glossary) · [需求](Client-Requirements) · [架构](Client-Architecture) · [数据模型](Client-Data-Model) · [API 契约](Client-Admin-API-Contract) · [界面](Client-UI-Specification) · [质量安全](Client-Quality-Security)
|
||
- Admin：[上手](Admin-Getting-Started) · [术语](Admin-Glossary) · [需求](Admin-Requirements) · [架构](Admin-Architecture) · [数据模型](Admin-Data-Model) · [Client API](Admin-Client-API) · [界面](Admin-UI-Specification) · [质量安全](Admin-Quality-Security) · [设备登记](Admin-Device-Registration-Guide) · [顺运宝](Admin-Shunyunbao-API) · [SQLite 到 MySQL](Admin-SQLite-to-MySQL) · [商品目录接口](Admin-Catalog-Integration-API)
|
||
|
||
## 事实来源
|
||
|
||
- 单次需求、变更、实现、测试、提交和验收：Gitea 工单。
|
||
- 长期稳定文档：Gitea Wiki。
|
||
- 代码和与版本绑定的 Wiki 镜像：Git 仓库。
|
||
- 产品红线和 Agent 执行规则：根 `AGENTS.md` 与子项目 `AGENTS.md`。
|
||
- Client–Admin 接口：Client 侧契约页面。
|
||
|
||
本地 `docs/` 是 Wiki 的只读镜像；必须先改在线 Wiki，再运行：
|
||
|
||
```powershell
|
||
python dev_scripts/harness.py sync --verify
|
||
```
|
||
|
||
历史 `docs/task` 在 2026-08-26 工作流切换前形成，冻结保留，不删除、不重命名、不批量重写。新任务默认不再创建第二份任务归档。
|