LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
班级小助手
班级小助手是给中小学班级用的一套信息管理系统。
老师发一条通知，教室那台机器上的灵动岛和 ClassIsland 会同时弹出来；
学生打开客户端就能看到当天的课表和作业。
🚀 软件下载 | 📚 使用文档 | 🧭 完整参考 | 💬 反馈问题
它由什么组成
一份代码，四个交付物：
| 装在哪 | 是什么 | 谁在用 |
|---|---|---|
| 教师的电脑 / 学校服务器 | 服务端（Express + Prisma + Socket.IO），同时托管 Web 管理端 | 其它三端 |
| 浏览器（手机也行） | Web 管理端（Vue 3 + Element Plus，PWA 可安装） | 老师、班主任、管理员 |
| 教室那台机器 / 学生电脑 | 桌面客户端（Electron + Vue 3），含「灵动岛」浮窗、托盘、离线缓存 | 教室大屏、学生 |
| 教室机器上的 ClassIsland | 联动插件（.NET 8 / C#），上报课表与上课状态、把老师的提醒弹到大屏上 | 教室机器 |
老师在 Web 端发布内容 → 服务端落库并按班级房间广播 → 客户端与灵动岛实时更新； 落到 ClassIsland 上的那部分走设备令牌的独立通道，教室网络不好也不影响。
功能
Web 管理端（老师 / 管理员）
- 仪表盘：本班人数、课程、课表、作业、通知、成绩一屏概览
- 班级管理：建班自动生成班级码与班级密码，随时更换班主任、添加协作教师
- 学生 / 教师管理：单个录入或导入名单（xlsx / xls / csv / tsv）
- 课表管理：按周排课、单双周，可直接从 ClassIsland 档案导入课表与节次时间
- 作业发布：按「所属日期」归类，支持附件与未交名单
- 通知发布：三档优先级；在上课时段发紧急通知会被拦下来并要求二次确认
- 叫人：点名某位同学到办公室，分「普通」与「紧急」两级
- 成绩录入：单条 / 批量 / 表格导入，带等级分布与得分率统计
- ClassIsland 联动：签发设备令牌、下发提醒、把课表镜像回教室大屏
- 数据库管理：连接体检、备份与恢复、SQLite ⇄ MySQL 一键切换
- 手机小屏适配，可「添加到主屏幕」当应用用
教室里的桌面客户端
- 班级码登录 —— 学生没有个人账号，一台教室机器代表一个班
- 课表：「今天」时间轴（大时钟 + 正在上 / 下一节 + 距下课倒计时）与周视图
- 作业看板：按科目分卡、可全屏铺满、字号可调，也能切回列表
- 通知中心：未读红点、优先级标签、点击自动标为已读
- 成绩总览：全班成绩表格 + 柱状图 + 等级分布
- 教室机器可直接录入作业、勾选未交名单
- 离线优先：断网回退 IndexedDB 缓存，恢复连接后自动同步
- 浅色 / 深色主题，跟随系统
灵动岛（桌面通知浮窗）
- 通知、新作业、叫人都会上岛：先是胶囊，点开是详情卡
- 多条消息展开为竖排列表，按重要程度排序，放不下时提示去应用内看
- 上课时段不打扰：普通通知暂存到下课再弹；紧急通知与叫人立刻弹
- 尺寸、圆角、字号、主题色、停靠位置（顶部 / 底部 × 左 / 中 / 右）都可以调
- 纯黑 / 毛玻璃 / 主题色渐变三种底
- 触摸屏（希沃白板这类一体机）也能点开
ClassIsland 联动
- 教室机器上报课表与上课状态，Web 端能看到「现在在上什么」
- 老师发的提醒在教室大屏上全屏弹出，支持语音朗读，播完回执不重复弹
- 可以把班级小助手排好的课表镜像回 ClassIsland，不影响老师原有的课表
- 提醒弹在客户端还是 ClassIsland，由教室那台机器自己选
部署与运维
- Windows 一键安装：内置 Node 运行时，双击安装、开机自启、自动建库建号
- Linux 一键安装 +
classhelper运维命令（systemd 托管，升级 / 回滚 / 备份） - Docker Compose（MySQL 版与 SQLite 版各一份）
- SQLite 与 MySQL 一键切换，备份与跨库迁移共用同一份 JSON 快照
软件截图
下面这些图都是脚本把程序真的跑起来截的（
node website/tools/capture-shots.mjs与客户端冒烟），不是示意图。
Web 管理端
展开其余页面……
| 页面 | 截图 |
|---|---|
| 仪表盘 | |
| 班级管理 |  |
| 学生管理 |  |
| 教师管理 |  |
| 课表管理 | |
| 作业发布 |  |
| 通知发布 |  |
| 成绩录入 |  |
| ClassIsland 联动 |  |
| 数据库管理 |  |
教室里的客户端
展开其余页面……
| 页面 | 截图 |
|---|---|
| 作业看板 |  |
| 通知 |  |
| 成绩 |  |
| 设置 · 灵动岛 |  |
| 设置 · 外观（深色主题） |  |
灵动岛
| 形态 | 截图 | 说明 |
|---|---|---|
| 新消息胶囊 |  |
非上课时段直接出现，点一下展开 |
| 点开后的详情 |  |
标题、内容、时间 + 打开应用 / 标为已读 / 知道了 |
| 多条消息列表 |  |
按重要程度排序，默认显示三条 |
| 上课期间的紧急通知 |  |
卡片内部红色呼吸光晕，无需点击 |
| 下课后补弹 |  |
上课期间暂存的通知，下课后自动弹出来 |
| 老师叫人 |  |
「请 XXX 同学找 XXX 老师」 |
| 新作业 |  |
教室机器自己录的那条不会弹给自己 |
手机上
展开……
| 场景 | 截图 |
|---|---|
| 抽屉菜单 |  |
| 通知发布 |  |
开始使用
| 装在哪 | 装什么 | 从 Releases 里拿 |
|---|---|---|
| 教师的电脑 / 学校服务器 | 服务端（内含 Web 管理端与 Node 运行时） | 班级小助手服务端-<版本>-x64-setup.exe |
| 教室机器 / 学生电脑 | 学生客户端 | 班级小助手-<版本>-x64-setup.exe，或 -portable.exe 免安装 |
| 教室机器的 ClassIsland | 联动插件 | ClassHelper.ClassIslandPlugin.cipx |
服务端装上就算跑起来了：双击安装程序，建库、建号、开机自启都由它自己办，
装完在浏览器打开 http://<服务器地址>:4000 就能登录。教师的电脑、学校的服务器、
一台常年开机的机器都可以装。
Linux 服务器有更省事的路子，一行命令装成 systemd 服务，并带上 classhelper 运维命令：
curl -fsSL -o /tmp/classhelper-install.sh https://raw.githubusercontent.com/LoveChengke/ClassHelper/master/deploy/install.sh && sudo bash /tmp/classhelper-install.sh
先体检、不改动系统的话，在末尾加上 --check。也可以走 Docker Compose，
完整步骤见部署指南与 Linux 运维手册。
获取帮助
- 使用文档：docs/ —— 分四块：第一次装、已经在用了、负责运维、要改代码
- 完整参考：docs/reference.md —— 功能口径、REST API、权限矩阵、验收证据
- 遇到问题 / 想提需求：提交 Issue
开发
| 层 | 选型 |
|---|---|
| 后端 | Node.js ≥ 20.19 + Express 5 + Prisma 7（SQLite / MySQL）+ Socket.IO |
| Web 管理端 | Vue 3 + Vite + Element Plus + Pinia |
| 桌面客户端 | Electron 44 + Vue 3 + IndexedDB 离线缓存（含独立的灵动岛渲染进程） |
| ClassIsland 插件 | .NET 8 / C# + Avalonia（ClassIsland 插件 API 2.0） |
| 共享契约 | packages/shared：类型、常量、权限矩阵、动效令牌 |
pnpm install
cp packages/server/.env.example packages/server/.env # 至少改 JWT_SECRET
pnpm db:generate
pnpm --filter @classhelper/server db:deploy # 根 scripts 里没有 db:deploy
pnpm build:shared # 三端与 seed 的前置产物
pnpm db:seed
pnpm dev # 后端 4000 + Web 端 5173
pnpm db:seed 会写一套演示数据（1 管理员 / 2 教师 / 3 个班 / 15 名学生 / 课表 / 作业 / 通知 / 成绩）：
| 角色 | 账号 | 密码 |
|---|---|---|
| 管理员 | admin |
admin123 |
| 教师 | teacher1 |
teacher123 |
| 学生端（班级） | 班级码 G101 |
123456 |
- AGENTS.md —— 工程约定与本机踩坑，改代码前先读它
- docs/reference.md —— 完整参考（功能行为、接口、验收记录）
- docs/dev/architecture.md —— 架构总览
致谢
灵动岛的视觉与架构参考 WinIsland（Windows 上的动态岛）； 动效语言取自 beUI；产品官网的版式参考 ClassIsland 官网。 三端的深色主题、图标与动效令牌都是照这些参考自己实现的，没有引入它们的运行时依赖。
如果这个项目对你有帮助，欢迎点亮 Star ⭐