# tcm-training

中医在线培训项目仓库，当前包含后台管理后端、后台管理前端，以及新增的 APP 端 `uni-app` 工程。

## 项目结构

```text
tcm-training/
├── tcm-training-admin-backend/   # Spring Boot 2.7 后端
├── tcm-training-admin/           # React 18 + Umi 管理后台
├── traditionalApp/               # uni-app APP 前端工程
├── doc/                          # 业务文档与原型说明
└── AGENTS.md                     # 仓库协作说明
```

## 子项目说明

### 1. `tcm-training-admin-backend`

- 技术栈：Spring Boot 2.7.18、MyBatis-Plus、Sa-Token、Redis、MySQL
- 主要代码目录：`src/main/java/com/tcm/training/admin/`
- 配置目录：`src/main/resources/`
- SQL 初始化脚本：`sql/init.sql`

常用命令：

```bash
cd "tcm-training-admin-backend"
mvn -DskipTests spring-boot:run
```

```bash
cd "tcm-training-admin-backend"
mvn test
```

### 2. `tcm-training-admin`

- 技术栈：React 18、Umi Max、Ant Design Pro、Jest、TypeScript
- 主要代码目录：`src/`
- 配置目录：`config/`

常用命令：

```bash
cd "tcm-training-admin"
npm install
npm run start:dev
```

```bash
cd "tcm-training-admin"
npm run build:prod
npm run test
npm run prettier
npm run tsc
```

### 3. `traditionalApp`

- 技术栈：`uni-app`、Vue 3、Pinia、`uview-pro`
- 入口文件：`main.js`、`App.vue`
- 页面配置：`pages.json`
- 应用配置：`manifest.json`
- 页面目录：`pages/`
- 公共组件目录：`components/`
- 公共工具目录：`utils/`

说明：

- 当前工程为标准 `uni-app` 项目结构，适合使用 HBuilderX 导入和运行。
- `traditionalApp/package.json` 目前是 `uni_modules` 组件包元数据，不是常规的工程脚本入口；因此仓库内没有统一的 `npm run dev`/`npm run build` 命令。
- `manifest.json` 已包含 App 打包配置，同时配置了微信小程序相关字段，后续若扩展多端发布，请以该文件为准维护。

推荐开发方式：

1. 使用 HBuilderX 打开 `traditionalApp/`
2. 通过 HBuilderX 运行到浏览器、模拟器或真机
3. 如需补充 npm 化构建流程，再单独整理脚本与依赖管理方案

## 开发建议

- 优先按子项目分别安装依赖，避免在仓库根目录执行包管理命令。
- 不要提交 `node_modules/`、`target/`、`unpackage/`、运行日志和本地环境配置。
- 前后端联调时，建议先启动后端，再启动管理后台或 APP 端。
- 每个函数或方法都需要编写注释，说明用途、参数或关键行为。
- 关键业务代码必须补充注释，重点解释业务规则、分支原因和约束条件。
- 代码注释语言应与所在文件现有注释语言保持一致。

## 文档目录

- `doc/`：业务需求、原型说明、字段文档
- `AGENTS.md`：面向协作代理/自动化工具的仓库约定

## 当前状态说明

仓库当前实际生效的前端包含两套：

- `tcm-training-admin/`：管理后台前端
- `traditionalApp/`：APP 端前端（新增 `uni-app` 工程）

后续新增子项目时，请同步更新本文件与 `AGENTS.md`，确保目录和启动方式始终与仓库一致。