Files
aijianhua/docs/项目说明.md

2.3 KiB
Raw Blame History

爱鉴花项目说明

项目结构

爱鉴花项目
├── mini_program (微信小程序矩阵目录)
├── backend (后端服务目录)
├── admin-system (管理后台目录)
├── website (官网目录)
├── docs (文档目录)
├── test (测试文件目录)
├── scripts (执行脚本目录)
├── 需求文档.md
├── 详细设计.md
├── 项目总览.md
├── start_project.bat (项目启动脚本)
└── 项目说明.md (本文档)

启动项目

双击运行 start_project.bat 脚本,将会打开所有子项目的文件夹,方便在编辑器中打开。

各项目开发环境配置

微信小程序 (uni-app)

  1. 开发工具: 安装 HBuilderX (推荐) 或 VSCode + uni-app 插件
  2. 环境要求: Node.js 16+npm 或 yarn 包管理器
  3. 开发步骤:
    • 导入 mini_program 文件夹到开发工具
    • 运行 npm install 安装依赖
    • 配置小程序AppID需要微信开发者账号
    • 运行开发服务器进行调试

后端服务 (Node.js)

  1. 环境要求: Node.js 16+MySQL 8.0+生产环境SQLite开发环境Redis
  2. 开发步骤:
    • 导入 backend 文件夹
    • 运行 npm install 安装依赖
    • 复制 .env.example.env 并配置数据库连接
    • 运行 npm run db:init 初始化数据库默认使用SQLite脚本位于 /scripts/backend/ 目录)
    • 运行 npm start 启动服务(开发环境使用 npm run dev

后台管理系统 (Vue3)

  1. 环境要求: Node.js 16+npm 或 yarn
  2. 开发步骤:
    • 导入 admin-system 文件夹
    • 运行 npm install 安装依赖
    • 配置后端API地址环境变量或配置文件
    • 运行 npm run serve 启动开发服务器

官方网站 (HTML5 Bootstrap)

  1. 环境要求: 任意现代浏览器
  2. 开发步骤:
    • 可直接在浏览器中打开 index.html 查看效果
    • 可使用 Live Server 等工具进行本地开发
    • 部署到 Nginx、Apache 或任何静态文件服务器

文档说明

  • 需求文档:描述项目需求和功能
  • 详细设计:描述系统架构和设计
  • 项目总览:汇总所有项目信息
  • 各子项目中的 README.md子项目介绍
  • 各子项目中的 功能模块.md子项目功能说明
  • 各子项目中的 开发计划.md子项目开发计划