2ba4250165
- monorepo: pnpm workspace + go.work + pyproject.toml + commitlint/husky - infra: docker-compose (minimal + full profiles) + init-sql + prometheus - arch-scan: multi-language scanner skeleton (TS/Go/Python/Proto) - shared-proto: buf v2 + classes.proto (ClassService CRUD contract) - api-gateway: Go/Gin + JWT HS256 auth + reverse proxy + request ID - classes: NestJS golden template (error system + observability + middleware + CRUD + tests) - teacher-portal: Next.js + paper-feel UI design system - CI/CD: 4 workflows (go/ts/py/proto) - docs: migration guide + project_rules + coding-standards + git-workflow + ui-design-system + 004 + 9 module READMEs + known-issues + spec/plan migration + roadmap
82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
# 模块索引
|
||
|
||
> 版本：1.0
|
||
> 日期：2026-07-07
|
||
> 状态：基线发布
|
||
> 关联文档：[架构影响地图](../architecture/004_architecture_impact_map.md)
|
||
|
||
---
|
||
|
||
## 模块分类总览
|
||
|
||
本项目采用 DDD + EDA + CQRS 微服务架构，包含 6 大业务限界上下文、2 个基础设施服务、3 个 BFF 聚合层、4 个微前端和 4 个共享包。
|
||
|
||
---
|
||
|
||
## 一、基础设施服务
|
||
|
||
| 服务 | 语言/框架 | 职责 | 阶段 | README |
|
||
|------|-----------|------|------|--------|
|
||
| api-gateway | Go (Gin) | 统一入口、路由转发、JWT 鉴权、限流熔断 | P1 | [README](./api-gateway/README.md) |
|
||
| push-gateway | Go (Gin) | WebSocket/SSE 长连接、实时消息推送 | P5 | [README](./push-gateway/README.md) |
|
||
|
||
---
|
||
|
||
## 二、领域微服务
|
||
|
||
| 服务 | 语言/框架 | 限界上下文 | 主要聚合 | 阶段 | README |
|
||
|------|-----------|-----------|----------|------|--------|
|
||
| iam | TS (NestJS) | 身份认证 | User、Role、Permission | P2 | [README](./iam/README.md) |
|
||
| core-edu | TS (NestJS) | 教学核心 | Class、Course、Assignment、Exam、Grade | P3 | [README](./core-edu/README.md) |
|
||
| content | TS (NestJS) | 内容资源 | Textbook、Question、KnowledgePoint | P4 | [README](./content/README.md) |
|
||
| data-ana | Python (FastAPI) | 数据分析 | Report、Mastery、Dashboard | P4 | [README](./data-ana/README.md) |
|
||
| msg | TS (NestJS) | 消息通知 | Message、Notification、Announcement | P5 | [README](./msg/README.md) |
|
||
| ai | Python (FastAPI) | AI 网关 | LLMCall、Prompt、Generation | P5 | [README](./ai/README.md) |
|
||
|
||
---
|
||
|
||
## 三、BFF 聚合层
|
||
|
||
| BFF | 语言/框架 | 服务对象 | 阶段 | README |
|
||
|-----|-----------|----------|------|--------|
|
||
| teacher-bff | TS (NestJS + GraphQL) | 教师端 | P2 | 待创建 |
|
||
| student-bff | TS (NestJS + GraphQL) | 学生端 | P3 | 待创建 |
|
||
| parent-bff | TS (NestJS + GraphQL) | 家长端 | P4 | 待创建 |
|
||
|
||
---
|
||
|
||
## 四、微前端
|
||
|
||
| 微前端 | 语言/框架 | 服务对象 | 阶段 | README |
|
||
|--------|-----------|----------|------|--------|
|
||
| teacher-portal | TS (Next.js + Module Federation) | 教师端 | P2 | 待创建 |
|
||
| student-portal | TS (Next.js + Module Federation) | 学生端 | P3 | 待创建 |
|
||
| parent-portal | TS (Next.js + Module Federation) | 家长端 | P4 | 待创建 |
|
||
| admin-portal | TS (Next.js + Module Federation) | 管理端 | P6 | 待创建 |
|
||
|
||
---
|
||
|
||
## 五、共享包
|
||
|
||
| 包 | 语言 | 用途 | 阶段 | README |
|
||
|----|------|------|------|--------|
|
||
| shared-proto | TS | protobuf 契约定义与代码生成 | P1 | 待创建 |
|
||
| shared-ts | TS | TypeScript 共享工具类型 | P1 | 待创建 |
|
||
| shared-go | Go | Go 共享工具 | P1 | 待创建 |
|
||
| shared-py | Python | Python 共享工具 | P4 | 待创建 |
|
||
|
||
---
|
||
|
||
## 阶段交付路线
|
||
|
||
| 阶段 | 周期 | 交付模块 | 退出标准 |
|
||
|------|------|----------|----------|
|
||
| P1 地基 | M1-M3 | api-gateway、classes（黄金模板）、shared-proto | classes 域 CRUD 端到端跑通 |
|
||
| P2 身份 | M4-M6 | iam、teacher-bff、teacher-portal | 教师可登录并看到空白 Dashboard |
|
||
| P3 核心教学 | M7-M10 | core-edu（合并 classes）、student-bff、student-portal | 考试→作答→批改→成绩全链路 |
|
||
| P4 内容分析 | M11-M13 | content、data-ana、parent-bff、parent-portal | 知识图谱查询 + 学情宽表 5s |
|
||
| P5 沟通AI | M14-M16 | msg、push-gateway、ai | 全校广播 + AI 辅助出题 |
|
||
| P6 硬化 | M17-M18 | admin-portal、Service Mesh | 99.9% 可用性 + 独立扩缩容 |
|
||
|
||
> 详细规划见 [路线图目录](../architecture/roadmap/README.md)
|