LuckyColor SaaS DocsLuckyColor SaaS 平台文档中心

这套文档解决什么问题 ​

• 帮助第一次接触 LuckyColor 的开发、测试、运维、实施同学快速看懂系统全貌。
• 帮助交付人员明确每个功能模块在前端、后端、数据库中的落点。
• 帮助部署人员理解 Spring Boot / NestJS 两套后端的本地启动、单机生产部署、Docker Compose 部署与 Nginx / HTTPS 配置。
• 帮助后续维护者在修改接口、数据库或更换后端技术栈时同步更新文档。

推荐阅读顺序 ​

1. 先看“产品总览”，快速理解平台定位、功能地图和仓库分工。
2. 再看“系统架构”，建立前端、后端、数据库、缓存和部署入口之间的关系。
3. 然后进入“前端文档”和“后端文档”，分别理解真实目录结构、运行配置和模块职责。
4. 需要联调时先看 双后端环境变量与默认值对照，再查看“接口规范”“数据库设计”“权限安全”。
5. 准备交付或上线时重点阅读“部署方案”。
6. 如果你要排查按钮显隐、接口 403 或核对前端权限值与后端校验点，再看 前后端权限码对照。
7. 如果你要继续补文档或统一口径，再看 参考项目与文档改进思路。
8. 如果你要按步骤推进这轮修复并持续打勾记录，直接看 Smoke 修复与功能链条任务板。

文档覆盖范围 ​

• 产品定位、适用场景、功能地图
• 前后端项目结构、双后端启动方式、环境变量与模块职责
• 多租户、RBAC、数据权限与系统日志设计
• 双后端环境变量默认值与前后端权限码对齐说明
• 数据库模型、初始化数据与常用索引思路
• 本地部署、单机生产部署、Docker Compose、Nginx / HTTPS、故障排查
• Spring Boot 独立说明，以及后端从 NestJS 对齐到 Java 时需要同步更新的文档项
• 高星 SaaS 文档参考、文档结构改进思路与后续补写方向
• 当前修复任务板、功能链条补文档任务与执行状态跟踪

适合谁阅读 ​

• 新加入项目、需要快速上手的前端或后端开发
• 需要安排环境、排查部署问题的运维与交付人员
• 需要理解平台能力边界的产品、测试与实施人员
• 后续要进行技术迁移、接口升级或数据库调整的维护者