LoveChengke
c7f215a09c
- 增加课件上传、班级可见范围、设备补收与传输进度 - 整合自定义灵动岛编辑器和相关客户端交互 - 同步三端契约、数据库迁移、部署配置与隔离回归 - 按源码统一文档与官网说明，移除过时任务书和审查记录 - 保持产品版本为 1.4.0
3.1 KiB
3.1 KiB
title, description
| title | description |
|---|---|
| 开发文档 | ClassHelper的架构、接口、数据模型、权限、动效层，以及验收与发版流程。 |
开发文档
ClassHelper是一个 pnpm monorepo，一份代码产出四个交付物：
| 交付物 | 位置 | 形态 |
|---|---|---|
| 后端服务 | packages/server |
Express 5 + Prisma 7 + Socket.IO，接口前缀 /api |
| Web 管理端 | packages/web-admin |
Vue 3 + Vite + Element Plus（教师 / 管理员用，PWA 可安装） |
| 桌面客户端 | packages/desktop-client |
Electron + Vue 3（ClassHelper 班级端 / 教室机器，含灵动岛浮窗） |
| 共享契约 | packages/shared |
三端共用的类型 / 常量 / 权限 / 工具函数 |
核心链路：
教师在 Web 端发布内容
│ REST API（JWT 鉴权）
▼
后端服务（Express + Prisma）
│ 写库 + 按班级房间广播
▼
Socket.IO ──► class:{classId} 房间 ──► 学生桌面客户端实时更新 UI（含灵动岛）
▲ │
└──── 老师下发的提醒 ◄──────┘
这一章有什么
| 页面 | 内容 |
|---|---|
| 架构总览 | 目录结构、技术栈、模块化设计、几条贯穿全局的约定 |
| REST API | 接口分组、常用路径与权限边界 |
| 实时事件（Socket.IO） | 事件清单、房间规则、新增事件要改哪三处 |
| 数据模型 | 模型职责、迁移与快照边界 |
| 角色与权限 | 权限矩阵与实现位置 |
| 动效层与主题 | beUI 令牌、CSS linear() 弹簧、深色主题 |
| 灵动岛设计令牌 | 岛逐项的几何 / 配色 / 排版 token |
| 验收与测试 | 隔离验收、后台冒烟与显式视觉模式 |
| 版本迭代与发布 | 改版本号、出安装包、发 Release 的完整流程 |