This commit is contained in:
Your Name
2026-03-23 18:02:16 +08:00
parent 18fee2e8f8
commit 250d173c2f
525 changed files with 10659 additions and 793 deletions
+377
View File
@@ -0,0 +1,377 @@
# 处方库功能 - 文档索引
## 📚 欢迎使用处方库管理系统
这是一个独立的中药处方模板管理系统,用于创建、管理和分享常用处方配方。
**版本:** v1.0.0
**状态:** ✅ 已完成并测试通过
**日期:** 2026-03-22
---
## 🚀 快速开始
### 第一次使用?从这里开始!
1. **[快速开始指南](QUICK_START_PRESCRIPTION_LIBRARY.md)** ⭐ 推荐
- 5分钟快速上手
- 创建第一个处方
- 常用操作说明
2. **[安装检查清单](INSTALLATION_CHECKLIST.md)**
- 详细的安装步骤
- 环境检查
- 问题排查
---
## 📖 完整文档
### 使用文档
| 文档名称 | 说明 | 适合人群 |
|---------|------|---------|
| [完整使用说明](PRESCRIPTION_LIBRARY_README.md) | 详细的功能说明和使用指南 | 所有用户 |
| [功能演示](PRESCRIPTION_LIBRARY_DEMO.md) | 使用场景和示例 | 新用户 |
| [快速开始](QUICK_START_PRESCRIPTION_LIBRARY.md) | 5分钟快速上手 | 新用户 ⭐ |
### 技术文档
| 文档名称 | 说明 | 适合人群 |
|---------|------|---------|
| [开发总结](PRESCRIPTION_LIBRARY_SUMMARY.md) | 技术实现和开发总结 | 开发人员 |
| [文件清单](PRESCRIPTION_LIBRARY_FILES.md) | 所有文件列表和说明 | 开发人员 |
| [交付文档](DELIVERY_PACKAGE.md) | 项目交付信息 | 项目经理 |
### 安装文档
| 文档名称 | 说明 | 适合人群 |
|---------|------|---------|
| [安装检查清单](INSTALLATION_CHECKLIST.md) | 详细的安装步骤和验证 | 运维人员 ⭐ |
| [测试SQL](TEST_PRESCRIPTION_LIBRARY.sql) | 测试数据和查询语句 | 测试人员 |
---
## 🔧 安装文件
### 自动安装脚本
| 文件名 | 平台 | 使用方法 |
|--------|------|---------|
| `install_prescription_library.bat` | Windows | 双击运行 |
| `install_prescription_library.sh` | Linux/Mac | `chmod +x install_prescription_library.sh && ./install_prescription_library.sh` |
### 手动安装
如果自动安装脚本无法运行,请执行:
```sql
server/database/migrations/create_prescription_library.sql
```
---
## 📂 文件结构
### 后端文件(PHP
```
server/
├── database/migrations/
│ └── create_prescription_library.sql # 数据库表结构
├── app/common/model/tcm/
│ └── PrescriptionLibrary.php # 数据模型
└── app/adminapi/
├── controller/tcm/
│ └── PrescriptionLibraryController.php # 控制器
├── logic/tcm/
│ └── PrescriptionLibraryLogic.php # 业务逻辑
├── lists/tcm/
│ └── PrescriptionLibraryLists.php # 列表逻辑
└── validate/tcm/
└── PrescriptionLibraryValidate.php # 数据验证
```
### 前端文件(Vue
```
admin/
└── src/
├── views/consumer/prescription/
│ └── list.vue # 处方库页面
└── api/
└── tcm.ts # API接口(已更新)
```
---
## 🎯 核心功能
### ✅ 已实现功能
1. **处方管理**
- 创建处方(处方名称 + 药材配方)
- 编辑处方
- 删除处方
- 查看处方详情
2. **药材管理**
- 动态添加药材
- 设置药材名称和剂量(克)
- 支持小数剂量(精确到0.1克)
3. **权限控制**
- 是否公开设置(仅自己可见/所有人可见)
- 查看权限控制
- 编辑权限控制
- 删除权限控制(仅创建者)
4. **搜索筛选**
- 按处方名称搜索(模糊匹配)
- 按是否公开筛选
- 分页显示
### 🔮 未来扩展
1. 处方分类功能
2. 处方标签功能
3. 使用统计功能
4. 导入导出功能
5. 处方评论功能
6. 版本管理功能
---
## 🔌 API接口
### 接口列表
| 接口路径 | 方法 | 说明 |
|---------|------|------|
| `/tcm.prescriptionLibrary/lists` | GET | 获取处方列表 |
| `/tcm.prescriptionLibrary/add` | POST | 添加处方 |
| `/tcm.prescriptionLibrary/edit` | POST | 编辑处方 |
| `/tcm.prescriptionLibrary/delete` | POST | 删除处方 |
| `/tcm.prescriptionLibrary/detail` | GET | 获取处方详情 |
详细说明请参阅:[开发总结](PRESCRIPTION_LIBRARY_SUMMARY.md)
---
## 💡 使用示例
### 示例1:六味地黄丸
```json
{
"prescription_name": "六味地黄丸",
"herbs": [
{"name": "熟地黄", "dosage": 24},
{"name": "山茱萸", "dosage": 12},
{"name": "山药", "dosage": 12},
{"name": "泽泻", "dosage": 9},
{"name": "牡丹皮", "dosage": 9},
{"name": "茯苓", "dosage": 9}
],
"is_public": 1
}
```
### 示例2:补中益气汤
```json
{
"prescription_name": "补中益气汤",
"herbs": [
{"name": "黄芪", "dosage": 15},
{"name": "党参", "dosage": 10},
{"name": "白术", "dosage": 10},
{"name": "当归", "dosage": 10},
{"name": "陈皮", "dosage": 6},
{"name": "升麻", "dosage": 6},
{"name": "柴胡", "dosage": 6},
{"name": "甘草", "dosage": 5}
],
"is_public": 1
}
```
更多示例请参阅:[功能演示](PRESCRIPTION_LIBRARY_DEMO.md)
---
## ❓ 常见问题
### Q1: 如何安装?
A: 运行安装脚本或手动执行SQL文件。详见:[安装检查清单](INSTALLATION_CHECKLIST.md)
### Q2: 如何创建处方?
A: 点击"新增处方"按钮,填写信息后保存。详见:[快速开始](QUICK_START_PRESCRIPTION_LIBRARY.md)
### Q3: 如何分享处方?
A: 创建处方时,将"是否公开"设置为"所有人可见"。
### Q4: 如何删除处方?
A: 只有创建者才能删除处方,点击"删除"按钮即可。
### Q5: 药材剂量可以是小数吗?
A: 可以,支持精确到0.1克,如:3.5克。
更多问题请参阅:[完整使用说明](PRESCRIPTION_LIBRARY_README.md)
---
## 🧪 测试
### 快速测试
1. 执行测试SQL插入测试数据:
```bash
mysql -u用户名 -p密码 数据库名 < TEST_PRESCRIPTION_LIBRARY.sql
```
2. 访问处方库页面,查看测试数据
3. 测试各项功能
详细测试步骤请参阅:[安装检查清单](INSTALLATION_CHECKLIST.md)
---
## 📊 技术栈
### 后端
- **框架:** ThinkPHP 6.x
- **语言:** PHP 7.4+
- **数据库:** MySQL 5.7+
### 前端
- **框架:** Vue 3
- **UI库:** Element Plus
- **语言:** TypeScript
---
## 🔐 权限说明
### 查看权限
- ✅ 可以查看自己创建的所有处方
- ✅ 可以查看其他人创建的公开处方
- ❌ 不能查看其他人创建的私有处方
### 编辑权限
- ✅ 可以编辑自己创建的处方
- ✅ 可以编辑其他人创建的公开处方
- ❌ 不能编辑其他人创建的私有处方
### 删除权限
- ✅ 只能删除自己创建的处方
- ❌ 不能删除其他人创建的处方
---
## 📝 更新日志
### v1.0.0 (2026-03-22)
- ✅ 初始版本发布
- ✅ 实现核心功能
- ✅ 完成文档编写
- ✅ 通过测试验收
---
## 🆘 技术支持
### 获取帮助
1. **查看文档**
- 先查看相关文档
- 查找常见问题
2. **问题反馈**
- 提供错误信息截图
- 提供操作步骤描述
- 提供浏览器控制台日志
3. **联系支持**
- 联系技术支持团队
---
## 📄 文档导航
### 按角色查看
#### 👨‍💼 管理员/使用者
1. [快速开始指南](QUICK_START_PRESCRIPTION_LIBRARY.md) ⭐
2. [完整使用说明](PRESCRIPTION_LIBRARY_README.md)
3. [功能演示](PRESCRIPTION_LIBRARY_DEMO.md)
#### 👨‍💻 开发人员
1. [开发总结](PRESCRIPTION_LIBRARY_SUMMARY.md) ⭐
2. [文件清单](PRESCRIPTION_LIBRARY_FILES.md)
3. [交付文档](DELIVERY_PACKAGE.md)
#### 🔧 运维人员
1. [安装检查清单](INSTALLATION_CHECKLIST.md) ⭐
2. [测试SQL](TEST_PRESCRIPTION_LIBRARY.sql)
#### 📋 项目经理
1. [交付文档](DELIVERY_PACKAGE.md) ⭐
2. [开发总结](PRESCRIPTION_LIBRARY_SUMMARY.md)
### 按任务查看
#### 🚀 安装部署
1. [安装检查清单](INSTALLATION_CHECKLIST.md)
2. [快速开始指南](QUICK_START_PRESCRIPTION_LIBRARY.md)
#### 📖 学习使用
1. [快速开始指南](QUICK_START_PRESCRIPTION_LIBRARY.md)
2. [功能演示](PRESCRIPTION_LIBRARY_DEMO.md)
3. [完整使用说明](PRESCRIPTION_LIBRARY_README.md)
#### 🔧 开发维护
1. [开发总结](PRESCRIPTION_LIBRARY_SUMMARY.md)
2. [文件清单](PRESCRIPTION_LIBRARY_FILES.md)
#### 📦 项目交付
1. [交付文档](DELIVERY_PACKAGE.md)
2. [文件清单](PRESCRIPTION_LIBRARY_FILES.md)
---
## ✅ 检查清单
### 安装前
- [ ] 已阅读快速开始指南
- [ ] 已备份数据库
- [ ] 已检查环境要求
### 安装中
- [ ] 已执行安装脚本
- [ ] 已配置菜单权限
- [ ] 已重启服务
### 安装后
- [ ] 已测试基本功能
- [ ] 已创建测试处方
- [ ] 已验证权限控制
---
## 🎉 开始使用
准备好了吗?让我们开始吧!
**推荐路径:**
1. 阅读 [快速开始指南](QUICK_START_PRESCRIPTION_LIBRARY.md)
2. 运行安装脚本
3. 创建第一个处方
4. 探索更多功能
**祝使用愉快!** 🚀
---
**版本:** v1.0.0
**最后更新:** 2026-03-22
**状态:** ✅ 已完成