From 028a45828357541ccf186d1abace88ab6efc6ca7 Mon Sep 17 00:00:00 2001 From: ylweng Date: Sun, 31 Aug 2025 23:29:26 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=E6=96=87=E6=A1=A3=EF=BC=8C=E5=AE=8C=E5=96=84=E9=9C=80=E6=B1=82?= =?UTF-8?q?=E5=92=8C=E6=8A=80=E6=9C=AF=E7=BB=86=E8=8A=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 46 + CONTRIBUTING.md | 171 + admin_website/.env.development | 18 + admin_website/package.json | 33 + admin_website/vue.config.js | 51 + backend/.env | 46 + backend/.env.development | 39 + backend/.env.example | 40 + backend/API接口文档.md | 275 ++ backend/README_DATABASE.md | 124 + backend/app.js | 108 + backend/config/database.js | 47 + backend/config/swagger.js | 153 + backend/middlewares/auth.js | 165 + backend/middlewares/errorHandler.js | 124 + backend/package-lock.json | 6642 +++++++++++++++++++++++++++ backend/package.json | 53 + backend/routes/auth.js | 218 + backend/routes/identifications.js | 355 ++ backend/routes/orders.js | 379 ++ backend/routes/products.js | 336 ++ backend/routes/users.js | 269 ++ backend/scripts/initDatabase.js | 165 + backend/utils/dbConnector.js | 152 + official_website/about.html | 326 ++ official_website/contact.html | 481 ++ official_website/css/style.css | 472 ++ official_website/index.html | 316 ++ official_website/js/main.js | 435 ++ official_website/news.html | 386 ++ official_website/products.html | 537 +++ official_website/robots.txt | 18 + official_website/sitemap.xml | 33 + 数据库设计文档.md | 137 + 部署指南.md | 367 ++ 35 files changed, 13517 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 admin_website/.env.development create mode 100644 admin_website/package.json create mode 100644 admin_website/vue.config.js create mode 100644 backend/.env create mode 100644 backend/.env.development create mode 100644 backend/.env.example create mode 100644 backend/API接口文档.md create mode 100644 backend/README_DATABASE.md create mode 100644 backend/app.js create mode 100644 backend/config/database.js create mode 100644 backend/config/swagger.js create mode 100644 backend/middlewares/auth.js create mode 100644 backend/middlewares/errorHandler.js create mode 100644 backend/package-lock.json create mode 100644 backend/package.json create mode 100644 backend/routes/auth.js create mode 100644 backend/routes/identifications.js create mode 100644 backend/routes/orders.js create mode 100644 backend/routes/products.js create mode 100644 backend/routes/users.js create mode 100644 backend/scripts/initDatabase.js create mode 100644 backend/utils/dbConnector.js create mode 100644 official_website/about.html create mode 100644 official_website/contact.html create mode 100644 official_website/css/style.css create mode 100644 official_website/index.html create mode 100644 official_website/js/main.js create mode 100644 official_website/news.html create mode 100644 official_website/products.html create mode 100644 official_website/robots.txt create mode 100644 official_website/sitemap.xml create mode 100644 数据库设计文档.md create mode 100644 部署指南.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..efd72b9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,46 @@ +# 变更日志 + +爱鉴花项目遵循[语义化版本](https://semver.org/lang/zh-CN/)。 + +## [未发布] + +### 新增 +- 初始化项目结构和文档 +- 创建微信小程序、后端服务、后台管理系统、官方网站四个子项目 +- 完善需求文档、详细设计文档、项目总览文档 +- 添加数据库配置和连接工具 +- 创建部署指南和贡献指南 + +### 变更 +- 优化项目文档结构和内容 +- 统一技术栈和开发规范 +- 完善开发环境配置说明 + +### 修复 +- 文档中的错误和遗漏信息 +- 开发环境配置问题 + +## 版本规范 + +### 版本格式 +`主版本号.次版本号.修订号` +- **主版本号**: 不兼容的API修改 +- **次版本号**: 向下兼容的功能性新增 +- **修订号**: 向下兼容的问题修正 + +### 发布周期 +- 主版本号: 重大功能更新或架构调整 +- 次版本号: 每月或每季度发布 +- 修订号: 根据需要随时发布 + +## 版本历史 + +### v0.1.0 - 2024-01-01 +- 项目初始版本 +- 基础框架搭建完成 +- 核心文档编写完成 +- 开发环境配置就绪 + +--- + +*变更日志格式参考 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)* \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3509ea3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,171 @@ +# 贡献指南 + +欢迎参与爱鉴花项目的开发!本文档将指导您如何为项目做出贡献。 + +## 🎯 开发流程 + +### 1. 环境准备 +- 确保已安装 Node.js 14.0.0+ +- 安装 Git 版本控制工具 +- 配置开发工具(HBuilderX、VSCode等) + +### 2. 获取代码 +```bash +git clone https://github.com/your-username/aijianhua.git +cd aijianhua +``` + +### 3. 分支管理 +我们使用 Git Flow 工作流: +- `main` - 主分支,用于生产环境 +- `develop` - 开发分支,集成所有功能 +- `feature/*` - 功能开发分支 +- `bugfix/*` - bug修复分支 +- `release/*` - 发布分支 + +### 4. 开发步骤 +1. 从 `develop` 分支创建功能分支 +2. 在分支上开发新功能或修复bug +3. 提交代码并推送到远程仓库 +4. 创建 Pull Request 到 `develop` 分支 +5. 代码审查通过后合并 + +## 📝 代码规范 + +### JavaScript/TypeScript +- 使用 ESLint + Prettier 进行代码格式化 +- 遵循 Airbnb JavaScript 风格指南 +- 使用 async/await 代替回调函数 +- 添加必要的注释和文档 + +### Vue/uni-app +- 使用 Composition API +- 组件命名使用 PascalCase +- Props 定义使用 TypeScript 类型 +- 使用 Vue Router 进行路由管理 + +### Node.js +- 使用 Express.js 框架 +- 中间件使用统一的错误处理 +- API 响应格式标准化 +- 使用 Winston 进行日志记录 + +## 🔧 提交规范 + +### Commit Message 格式 +``` +(): + + + +