b25aa5b143
- 基于 NestJS + TypeScript + MySQL + Redis 架构 - 完整的模块化设计（认证、用户、小组、游戏、预约等） - JWT 认证和 RBAC 权限控制系统 - Docker 容器化部署支持 - 添加 CLAUDE.md 项目开发指南 - 配置 .gitignore 忽略文件 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
GameGroup 项目文档目录
本目录包含 GameGroup 后端项目的所有文档。
📁 目录结构
doc/
├── api/ # API 相关文档
│ └── API文档.md # 完整的 API 接口文档
├── deployment/ # 部署相关文档
│ ├── DEPLOYMENT.md # Docker 部署指南
│ └── 部署指导文档.md # 详细部署说明
├── development/ # 开发相关文档
│ ├── PHASE5_OPTIMIZATION.md # 第五阶段优化计划
│ ├── 修改记录.md # 项目修改记录
│ └── 开发步骤文档.md # 完整的开发步骤文档
└── testing/ # 测试相关文档
└── test-summary.md # 测试总结报告
📚 文档说明
API 文档
- API文档.md: 包含所有 API 接口的详细说明，包括请求方法、参数、响应格式等
- 认证相关接口
- 用户管理接口
- 小组管理接口
- 游戏库接口
- 预约管理接口
- 账目管理接口
- 排班助手接口
- 黑名单系统接口
- 荣誉墙接口
- 资产管理接口
- 积分系统接口
- 竞猜系统接口
部署文档
-
DEPLOYMENT.md: Docker 容器化部署指南
- Docker 镜像构建
- Docker Compose 配置
- 环境变量配置
- 部署步骤说明
-
部署指导文档.md: 详细的部署指导
- 服务器环境准备
- 数据库配置
- Redis 配置
- 应用部署
- 常见问题解决
开发文档
-
开发步骤文档.md: 项目开发完整流程
- 第一阶段：项目初始化与基础配置
- 第二阶段：核心基础设施
- 第三阶段：核心业务模块开发
- 第四阶段：高级功能模块
- 第五阶段：集成与优化
- 第六阶段：测试与部署
-
PHASE5_OPTIMIZATION.md: 第五阶段优化计划
- 性能优化策略
- 缓存优化方案
- 数据库优化
- API 优化
-
修改记录.md: 项目重要修改记录
- 功能更新记录
- Bug 修复记录
- 重构记录
测试文档
- test-summary.md: 测试总结报告
- 单元测试统计
- 测试覆盖率
- 测试结果分析
- 待修复问题列表
🔗 相关链接
- 项目 README - 项目总体介绍
- Swagger API 文档 - 在线 API 文档（开发环境）
- 数据库初始化脚本 - 数据库表结构
📝 文档更新
文档最后更新时间：2025-12-19
如有文档更新需求，请按以下规范进行：
- 保持文档格式统一
- 更新文档末尾的更新时间
- 在修改记录中记录重大变更
- 保持 API 文档与代码同步
注意: 本目录下的所有文档均为项目内部文档，包含敏感信息，请勿泄露给外部人员。