Guoguo
0feb900a1d
- 01-快速开始: local setup for all 3 modules, common issues - 02-配置说明: all env vars, WeChat/Pay/DB/COS config details - 03-架构说明: system overview, directory structure, data flows - 04-部署指南: Tencent Cloud SCF/COS deployment, launch checklist - 05-API接口文档: all 42 endpoints with params and response format - README index with audience guide and quick links
1.5 KiB
1.5 KiB
开发文档
光子美容仪项目开发文档，面向开发者和运维人员。
目录
| 文档 | 说明 | 适合谁读 |
|---|---|---|
| 01-快速开始 | 本地环境搭建、三端启动步骤、常见问题 | 新加入的开发者 |
| 02-配置说明 | 所有环境变量详解、微信/支付/数据库/COS 配置 | 开发者、运维 |
| 03-架构说明 | 系统架构、目录结构、数据流、模块设计 | 需要改代码的开发者 |
| 04-部署指南 | 腾讯云 SCF/COS 部署、数据库初始化、上线检查清单 | 运维、负责发布的人 |
| 05-API接口文档 | 全部 42 个 API 接口的方法、参数、响应格式 | 前后端开发者 |
项目结构
jw-beauty/
├── miniprogram/ 小程序（微信原生）
├── server/ 后端（Express + SCF）
├── admin-console/ 管理后台（Vue 3 + uni-app H5）
└── docs/ 文档
├── dev/ 开发文档（本目录）
├── design/ 设计文档
├── protocols/ BLE 协议文档
└── deploy/ 部署笔记
快速链接
- 本地启动后端：
cd server && npm install && npm start - 健康检查：
curl http://localhost:3000/health - 管理后台开发：
cd admin-console && npm install && npm run dev:h5 - 数据库初始化：
cd server && npm run db:init