Files
aijianhua/README.md

124 lines
3.2 KiB
Markdown
Raw Normal View History

2025-08-30 15:52:52 +08:00
# 爱鉴花项目
## 项目概述
爱鉴花是一个集花卉识别、电商交易、社区交流于一体的综合性平台,包含微信小程序、管理后台、官方网站等多个端。
## 目录结构
```
爱鉴花项目/
├── 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 16+
- MySQL 5.7+
- Redis
- 微信开发者工具
### 快速开始
1. 克隆项目
```bash
git clone <repository-url>
cd aijianhua
```
2. 安装依赖
```bash
# 后端服务
cd backend && npm install
# 管理后台
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
- 开发者微信群: 请联系项目管理员