forked from datawhale/whale-town-end
docs:优化项目文档结构和架构说明
- 优化主README.md的文件结构总览,采用总分结构设计 - 大幅改进docs/ARCHITECTURE.md,详细说明业务功能模块化架构 - 新增docs/DOCUMENT_CLEANUP.md记录文档清理过程 - 更新docs/README.md添加新文档的导航链接 本次更新完善了项目文档体系,便于开发者快速理解项目架构
This commit is contained in:
63
README.md
63
README.md
@@ -124,29 +124,48 @@ pnpm run dev
|
||||
|
||||
### 第二步:熟悉项目架构 🏗️
|
||||
|
||||
**📁 项目文件结构总览**
|
||||
|
||||
```
|
||||
项目根目录/
|
||||
├── src/ # 源代码目录
|
||||
│ ├── business/ # 业务功能模块(按功能组织)
|
||||
│ │ ├── auth/ # 🔐 用户认证模块
|
||||
│ │ ├── user-mgmt/ # 👥 用户管理模块
|
||||
│ │ ├── admin/ # 🛡️ 管理员模块
|
||||
│ │ ├── security/ # 🔒 安全模块
|
||||
│ │ └── shared/ # 🔗 共享组件
|
||||
│ ├── core/ # 核心技术服务
|
||||
│ │ ├── db/ # 数据库层(支持MySQL/内存双模式)
|
||||
│ │ ├── redis/ # Redis缓存服务(支持真实Redis/文件存储)
|
||||
│ │ ├── login_core/ # 登录核心服务
|
||||
│ │ ├── admin_core/ # 管理员核心服务
|
||||
│ │ └── utils/ # 工具服务(邮件、验证码、日志)
|
||||
│ ├── app.module.ts # 应用主模块
|
||||
│ └── main.ts # 应用入口
|
||||
├── client/ # 前端管理界面
|
||||
├── docs/ # 项目文档
|
||||
├── test/ # 测试文件
|
||||
├── redis-data/ # Redis文件存储数据
|
||||
├── logs/ # 日志文件
|
||||
└── 配置文件 # .env, package.json, tsconfig.json等
|
||||
whale-town-end/ # 🐋 项目根目录
|
||||
├── 📂 src/ # 源代码目录
|
||||
│ ├── 📂 business/ # 🎯 业务功能模块(按功能组织)
|
||||
│ │ ├── 📂 auth/ # 🔐 用户认证模块
|
||||
│ │ ├── 📂 user-mgmt/ # 👥 用户管理模块
|
||||
│ │ ├── 📂 admin/ # 🛡️ 管理员模块
|
||||
│ │ ├── 📂 security/ # 🔒 安全防护模块
|
||||
│ │ ├── 📂 zulip/ # 💬 Zulip集成模块
|
||||
│ │ └── 📂 shared/ # 🔗 共享业务组件
|
||||
│ ├── 📂 core/ # ⚙️ 核心技术服务
|
||||
│ │ ├── 📂 db/ # 🗄️ 数据库层(MySQL/内存双模式)
|
||||
│ │ ├── 📂 redis/ # 🔴 Redis缓存(真实Redis/文件存储)
|
||||
│ │ ├── 📂 login_core/ # 🔑 登录核心服务
|
||||
│ │ ├── 📂 admin_core/ # 👑 管理员核心服务
|
||||
│ │ ├── 📂 zulip/ # 💬 Zulip核心服务
|
||||
│ │ └── 📂 utils/ # 🛠️ 工具服务(邮件、验证码、日志)
|
||||
│ ├── 📄 app.module.ts # 🏠 应用主模块
|
||||
│ └── 📄 main.ts # 🚀 应用入口点
|
||||
├── 📂 client/ # 🎨 前端管理界面
|
||||
│ ├── 📂 src/ # 前端源码
|
||||
│ ├── 📂 dist/ # 前端构建产物
|
||||
│ ├── 📄 package.json # 前端依赖配置
|
||||
│ └── 📄 vite.config.ts # Vite构建配置
|
||||
├── 📂 docs/ # 📚 项目文档中心
|
||||
│ ├── 📂 api/ # 🔌 API接口文档
|
||||
│ ├── 📂 development/ # 💻 开发指南
|
||||
│ ├── 📂 deployment/ # 🚀 部署文档
|
||||
│ ├── 📄 ARCHITECTURE.md # 🏗️ 架构设计文档
|
||||
│ └── 📄 README.md # 📖 文档导航中心
|
||||
├── 📂 test/ # 🧪 测试文件目录
|
||||
├── 📂 config/ # ⚙️ 配置文件目录
|
||||
├── 📂 logs/ # 📝 日志文件存储
|
||||
├── 📂 redis-data/ # 💾 Redis文件存储数据
|
||||
├── 📂 dist/ # 📦 后端构建产物
|
||||
├── 📄 .env # 🔧 环境变量配置
|
||||
├── 📄 package.json # 📋 项目依赖配置
|
||||
├── 📄 docker-compose.yml # 🐳 Docker编排配置
|
||||
├── 📄 Dockerfile # 🐳 Docker镜像配置
|
||||
└── 📄 README.md # 📖 项目主文档(当前文件)
|
||||
```
|
||||
|
||||
**架构特点:**
|
||||
|
||||
Reference in New Issue
Block a user