docs: 更新项目文档,完善需求和技术细节
This commit is contained in:
28
docs/README.md
Normal file
28
docs/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# 爱鉴花项目文档中心
|
||||
|
||||
## 项目介绍
|
||||
这是爱鉴花项目的完整文档中心,包含所有技术文档、API说明和部署指南。
|
||||
|
||||
## 技术栈
|
||||
- Node.js
|
||||
- Express.js
|
||||
- SQLite(开发环境)
|
||||
- MySQL(生产环境)
|
||||
- Redis
|
||||
|
||||
## 文档结构
|
||||
- 需求文档: 项目业务需求和功能说明
|
||||
- 设计文档: 系统架构、数据库设计和详细设计
|
||||
- API文档: 前后端接口规范和说明
|
||||
- 部署指南: 环境配置和部署流程
|
||||
- 开发计划: 项目开发进度和任务安排
|
||||
|
||||
## 开发说明
|
||||
请确保安装了Node.js环境,并使用npm管理依赖。
|
||||
|
||||
## 文档
|
||||
|
||||
- [开发计划](./开发计划.md)
|
||||
- [功能模块](./功能模块.md)
|
||||
- [数据库设计](./数据库设计文档.md)
|
||||
- [API接口文档](./API接口文档.md)
|
||||
Reference in New Issue
Block a user