docs:更新README、贡献者文档和部署指南

- 更新README.md:添加管理员后台系统介绍,更新测试统计为154个用例
- 更新CONTRIBUTORS.md:补充jianuo的管理员后台开发贡献,更新项目里程碑
- 更新DEPLOYMENT.md:完善前后端分离部署方案,添加管理员后台配置说明
- 反映最新管理员后台功能的部署要求和配置变更
This commit is contained in:
moyin
2025-12-22 15:13:04 +08:00
parent 2fb46967c7
commit d80d2c5cb8
3 changed files with 294 additions and 64 deletions

View File

@@ -12,11 +12,12 @@
Whale Town 是一个功能完整的像素游戏后端服务,提供:
- 🔐 **完整用户认证系统** - 支持邮箱验证、密码重置、第三方登录
- 🎛️ **管理员后台系统** - React + Ant Design用户管理、日志监控、权限控制
- 📧 **智能邮件服务** - 支持测试模式和生产模式自动切换
- 🗄️ **灵活存储方案** - Redis文件存储 + 内存数据库,支持无依赖测试
- 🚀 **高性能架构** - 基于NestJS支持WebSocket实时通信
- 📚 **完整API文档** - Swagger UI + OpenAPI规范
- 🧪 **全面测试覆盖** - 单元测试 + API功能测试
- 🧪 **全面测试覆盖** - 154个单元测试用例全部通过
---
@@ -46,22 +47,34 @@ pnpm run dev
🎉 **服务启动成功!** 访问 http://localhost:3000
### 🧑‍💻 管理员后台Ant Design
### 🧑‍💻 管理员后台系统
项目包含一个最小可用的管理员后台(管理员登录 / 用户管理 / 重置密码),文档见
项目包含一个功能完整的管理员后台系统,基于 React + Ant Design 构建
- [docs/systems/admin-dashboard/README.md](docs/systems/admin-dashboard/README.md)
**🎛️ 核心功能:**
- 管理员身份认证独立Token系统
- 用户列表管理与搜索
- 用户密码重置功能
- 运行时日志查看与下载
- 响应式界面设计
启动方式:
**📚 详细文档:** [docs/systems/admin-dashboard/README.md](docs/systems/admin-dashboard/README.md)
**🚀 快速启动:**
```bash
# 1. 安装依赖
pnpm install
# 后端
# 2. 启动后端服务
pnpm run dev
# 前端后台
# 3. 启动前端管理界面
pnpm -C client dev
# 4. 访问管理后台
# 地址: http://localhost:5173
# 账号: admin / Admin123456
```
### 🧪 快速测试
@@ -238,6 +251,13 @@ pnpm -C client dev
- **第三方登录** - GitHub OAuth支持
- **权限控制** - 基于角色的访问控制
### 🎛️ 管理员后台系统
- **独立认证** - 专用Token系统与用户系统隔离
- **用户管理** - 用户列表、搜索、密码重置
- **日志监控** - 实时日志查看、历史日志下载
- **权限控制** - 管理员角色验证role=9
- **现代界面** - React + Ant Design响应式设计
### 📧 智能邮件服务
- **测试模式** - 控制台输出无需SMTP服务器
- **生产模式** - 支持主流邮件服务商
@@ -304,8 +324,8 @@ pnpm run test:cov
### 📈 测试覆盖率
- **单元测试**: 114个测试用例 ✅
- **功能测试**: 用户认证、邮件验证、数据存储 ✅
- **单元测试**: 154个测试用例 ✅
- **功能测试**: 用户认证、邮件验证、数据存储、管理员后台
- **集成测试**: 完整业务流程 ✅
---