117 lines
2.9 KiB
Markdown
117 lines
2.9 KiB
Markdown
# 项目文档导航
|
||
|
||
## 📚 项目结构
|
||
|
||
本项目包含两个主要部分：
|
||
|
||
### 后端项目 (Go)
|
||
- 目录：`go/`
|
||
- 文档：[go/docs/README.md](./go/docs/README.md)
|
||
- 技术栈：Go + Beego + MySQL
|
||
|
||
### 前端项目 (Platform)
|
||
- 目录：`platform/`
|
||
- 文档：[platform/docs/README.md](./platform/docs/README.md)
|
||
- 技术栈：Vue 3 + Element Plus + Vite
|
||
|
||
### 移动端项目 (BabyHealth)
|
||
- 目录：`babyhealth/`
|
||
- 技术栈：uni-app
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 后端启动
|
||
|
||
```bash
|
||
cd go
|
||
go mod download
|
||
bee run
|
||
```
|
||
|
||
详细文档：[go/docs/服务端启动命令.md](./go/docs/服务端启动命令.md)
|
||
|
||
### 前端启动
|
||
|
||
```bash
|
||
cd platform
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
## 📖 核心功能文档
|
||
|
||
### 存储配置功能（最新）
|
||
|
||
完整的文件存储解决方案，支持本地存储和七牛云存储：
|
||
|
||
- **快速开始**：[go/docs/QUICK_START.md](./go/docs/QUICK_START.md)
|
||
- **完整说明**：[go/docs/README_STORAGE.md](./go/docs/README_STORAGE.md)
|
||
- **使用指南**：[go/docs/storage-config-guide.md](./go/docs/storage-config-guide.md)
|
||
- **部署清单**：[go/docs/DEPLOYMENT_CHECKLIST.md](./go/docs/DEPLOYMENT_CHECKLIST.md)
|
||
- **实现报告**：[go/docs/IMPLEMENTATION_COMPLETE.md](./go/docs/IMPLEMENTATION_COMPLETE.md)
|
||
|
||
### 其他功能
|
||
|
||
- **后端开发**：[go/docs/后端开发规则.md](./go/docs/后端开发规则.md)
|
||
- **接口文档**：[go/docs/接口文件.md](./go/docs/接口文件.md)
|
||
- **字典使用**：[platform/docs/dictionary-usage.md](./platform/docs/dictionary-usage.md)
|
||
- **图片上传**：[platform/docs/调用图片上传组件.md](./platform/docs/调用图片上传组件.md)
|
||
|
||
## 🗂️ 文档组织
|
||
|
||
```
|
||
项目根目录/
|
||
├── README.md # 本文件（总导航）
|
||
├── go/ # 后端项目
|
||
│ ├── docs/ # 后端文档
|
||
│ │ ├── README.md # 后端文档索引
|
||
│ │ ├── QUICK_START.md # 快速开始
|
||
│ │ ├── README_STORAGE.md # 存储功能说明
|
||
│ │ └── ... # 其他文档
|
||
│ └── ...
|
||
├── platform/ # 前端项目
|
||
│ ├── docs/ # 前端文档
|
||
│ │ ├── README.md # 前端文档索引
|
||
│ │ └── ... # 其他文档
|
||
│ └── ...
|
||
└── babyhealth/ # 移动端项目
|
||
└── ...
|
||
```
|
||
|
||
## 🔧 开发环境
|
||
|
||
### 必需软件
|
||
|
||
- Go 1.17+
|
||
- Node.js 14+
|
||
- MySQL 5.7+
|
||
- Git
|
||
|
||
### 推荐工具
|
||
|
||
- VS Code
|
||
- Postman
|
||
- MySQL Workbench
|
||
- Git GUI
|
||
|
||
## 📝 开发规范
|
||
|
||
- 后端开发规范：[go/docs/后端开发规则.md](./go/docs/后端开发规则.md)
|
||
- 前端代码规范：遵循 Vue 3 官方风格指南
|
||
- Git 提交规范：使用语义化提交信息
|
||
|
||
## 🐛 问题反馈
|
||
|
||
如遇到问题，请：
|
||
1. 查看相关文档
|
||
2. 检查日志文件
|
||
3. 提交 Issue
|
||
|
||
## 📄 许可证
|
||
|
||
本项目遵循相应的开源许可证。
|
||
|
||
---
|
||
|
||
**最后更新**: 2024-01-01
|