vifo
6b83b7cbc9
- 添加前端设计文档（rui-admin、收银系统、模块打包） - 添加前端实施计划（收银后台功能完善） - 添加通用规范（API、编码、数据库、前端开发规则） - 建立文档索引和使用指南
58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
# rui-frontend 文档中心
|
||
|
||
> 本目录包含前端项目相关的设计文档、实施计划和开发规范。
|
||
> 文档来源：`spring-ai/docs`（后端仓库），定期同步更新。
|
||
|
||
## 📁 目录结构
|
||
|
||
```
|
||
docs/
|
||
├── design/ # 设计文档
|
||
│ ├── rui-admin功能设计文档.md
|
||
│ ├── cashier-design.md
|
||
│ └── admin-ui-module-build-design.md
|
||
├── plans/ # 实施计划
|
||
│ └── cashier-admin-implementation.md
|
||
├── standards/ # 开发规范
|
||
│ ├── 前端开发规则.md
|
||
│ └── API设计规范.md
|
||
└── README.md # 本文档
|
||
```
|
||
|
||
## 📋 文档说明
|
||
|
||
### 设计文档（design/）
|
||
|
||
| 文档 | 说明 | 来源 |
|
||
|------|------|------|
|
||
| `rui-admin功能设计文档.md` | rui-admin 管理后台功能模块设计 | spring-ai/docs |
|
||
| `cashier-design.md` | 收银系统（POS）整体架构设计 | spring-ai/docs/superpowers/specs |
|
||
| `admin-ui-module-build-design.md` | Admin-UI 分模块打包功能设计 | spring-ai/docs/superpowers/specs |
|
||
|
||
### 实施计划（plans/）
|
||
|
||
| 文档 | 说明 | 来源 |
|
||
|------|------|------|
|
||
| `cashier-admin-implementation.md` | 收银系统后台管理功能完善实施计划 | spring-ai/docs/superpowers/plans |
|
||
|
||
### 开发规范（standards/）
|
||
|
||
| 文档 | 说明 | 来源 |
|
||
|------|------|------|
|
||
| `前端开发规则.md` | 前端编码规范、目录结构、命名约定 | spring-ai/docs |
|
||
| `API设计规范.md` | RESTful API 设计规范 | spring-ai/docs |
|
||
|
||
## 🔄 同步说明
|
||
|
||
当后端仓库 `spring-ai/docs` 中的文档更新时，前端仓库应同步更新副本：
|
||
|
||
```bash
|
||
# 示例：同步收银系统设计文档
|
||
cp ~/rhkj/spring-ai/docs/superpowers/specs/2026-06-03-cashier-design.md \
|
||
~/rhkj/rui-frontend/docs/design/cashier-design.md
|
||
```
|
||
|
||
## 📝 新增文档
|
||
|
||
如需新增前端专属文档，直接在此目录下创建，无需同步到后端仓库。
|