docs: 更新项目文档，完善需求和技术细节

2025-09-01 02:35:41 +08:00
parent e1647902e2
commit ad20888cd4
57 changed files with 961 additions and 156 deletions
--- a/README.md
+++ b/README.md
@@ -1,57 +1,124 @@
 # 爱鉴花项目

-## 🌸 项目概述
-爱鉴花是一款创新的AI植物识别微信小程序，集植物识别、花卉商城、配送服务、园艺知识于一体，为用户提供全方位的花卉相关服务。
+## 项目概述

-## 🏗️ 项目组成
- **微信小程序 (uni-app)**: 用户端应用，提供拍照识别、购物、配送等功能
- **后端接口 (Node.js)**: RESTful API服务，支持所有业务功能
- **后台管理系统 (Vue3)**: 管理后台，用于数据管理和统计分析
- **官方网站 (HTML5 Bootstrap)**: 公司展示网站，提供品牌宣传和产品介绍
+爱鉴花是一个集花卉识别、电商交易、社区交流于一体的综合性平台，包含微信小程序、管理后台、官方网站等多个端。

-## ✨ 核心功能
- **AI植物识别**: 拍照或上传图片，智能识别植物种类
- **花卉商城**: 丰富的花卉商品，支持在线购买
- **配送服务**: 同城配送，实时订单跟踪
- **园艺知识**: 专业的植物养护指南和工具推荐
- **用户中心**: 个人信息管理、订单历史、收藏功能
+## 目录结构

-## 🚀 快速开始
+```
+爱鉴花项目/
+├── backend/           # 后端服务目录 (Node.js + Express)
+├── admin-system/      # 管理后台目录 (Vue3)
+├── website/           # 官网目录 (HTML5 + Bootstrap)
+├── mini_program/      # 微信小程序矩阵目录 (uni-app)
+├── docs/              # 文档目录
+├── test/              # 测试文件目录
+├── scripts/           # 执行脚本目录
+└── README.md          # 项目说明
+```
+
+## 模块说明
+
+### 后端服务 (backend)
+- 基于Node.js和Express框架开发
+- 提供RESTful API接口
+- 支持用户认证、商品管理、订单处理、花卉识别等功能
+- 开发环境使用SQLite，生产环境使用MySQL
+
+### 管理后台 (admin-system)
+- 基于Vue3开发的管理系统
+- 提供用户管理、商品管理、订单管理、数据统计等功能
+- 支持权限控制和数据可视化
+
+### 官方网站 (website)
+- 基于HTML5和Bootstrap开发的响应式网站
+- 包含公司介绍、产品展示、新闻动态、联系方式等模块
+- 支持多设备适配和SEO优化
+
+### 微信小程序矩阵 (mini_program)
+- 基于uni-app开发的微信小程序矩阵
+- 提供花卉识别、商品浏览、在线购买、社区交流等功能
+- 支持微信支付和用户授权登录
+
+### 文档目录 (docs)
+- 包含需求文档、设计文档、API文档、部署指南等完整文档
+- 提供项目开发、部署和维护的全套说明
+
+### 测试文件目录 (test)
+- 包含单元测试、集成测试、端到端测试等测试文件
+- 支持自动化测试和持续集成
+
+### 执行脚本目录 (scripts)
+- 包含项目部署、数据库初始化、环境配置等执行脚本
+- 提供一键式部署和运维支持
+
+## 开发环境

 ### 环境要求
- Node.js 14.0.0+
+- Node.js 16+
 - MySQL 5.7+
 - Redis
 - 微信开发者工具

-### 开发步骤
-1. 克隆项目到本地
-2. 按照各子项目的README配置开发环境
-3. 配置数据库连接信息
-4. 安装依赖并启动服务
+### 快速开始

-## 📁 项目结构
-```
-爱鉴花项目/
-├── mini_program/          # 微信小程序
-├── backend/               # 后端服务
-├── admin_website/         # 后台管理系统
-├── official_website/      # 官方网站
-├── 需求文档.md            # 产品需求文档
-├── 详细设计.md            # 技术设计文档
-├── 项目总览.md            # 项目总体信息
-├── 部署指南.md            # 部署操作指南
-└── README.md             # 项目说明文档
+1. 克隆项目
+```bash
+git clone <repository-url>
+cd aijianhua
 ```

-## 📄 相关文档
- [需求文档](./需求文档.md) - 产品功能需求说明
- [详细设计](./详细设计.md) - 技术架构和设计细节
- [项目总览](./项目总览.md) - 项目总体信息和计划
- [部署指南](./部署指南.md) - 系统部署和运维指南
- [数据库设计](./数据库设计文档.md) - 数据库表结构和设计
- [贡献指南](./CONTRIBUTING.md) - 开发规范和贡献流程
- [变更日志](./CHANGELOG.md) - 版本更新记录
+2. 安装依赖
+```bash
+# 后端服务
+cd backend && npm install

-## 🤝 参与贡献
-欢迎提交Issue和Pull Request来完善这个项目。
+# 管理后台  
+cd admin-system && npm install
+
+# 微信小程序
+cd mini_program && npm install
+```
+
+3. 配置环境变量
+```bash
+# 复制环境变量示例文件
+cp backend/.env.example backend/.env
+cp admin-system/.env.example admin-system/.env.development
+```
+
+4. 启动服务
+```bash
+# 启动后端服务
+cd backend && npm run dev
+
+# 启动管理后台
+cd admin-system && npm run serve
+
+# 启动官方网站
+cd website && python3 -m http.server 8080
+```
+
+## 文档资源
+
+详细文档请查看 [docs目录](./docs/)：
+- [需求文档](./docs/需求文档.md)
+- [数据库设计](./docs/数据库设计文档.md)  
+- [API接口文档](./docs/API接口文档.md)
+- [部署指南](./docs/部署指南.md)
+- [开发计划](./docs/开发计划.md)
+
+## 贡献指南
+
+请参考 [CONTRIBUTING.md](./docs/CONTRIBUTING.md) 文档了解如何参与项目开发。
+
+## 许可证
+
+本项目采用 MIT 许可证，详见 [LICENSE](./docs/LICENSE.md) 文件。
+
+## 联系方式
+
+- 项目邮箱: aijianhua@example.com
+- 问题反馈: GitHub Issues
+- 开发者微信群: 请联系项目管理员