ClassHelper文档

ClassHelper（Class Helper）是给中小学班级用的一套信息管理系统。一份代码，三个交付物： 装在服务器上的后端、给老师用的 Web 管理端、装在教室机器的桌面客户端（ClassHelper 班级端 / 教室大屏）。

老师发一条通知，教室那台机器上的客户端和灵动岛会实时显示；学生打开客户端就能看到当天的课表和作业。

第一次装 从零把服务端、管理端、ClassHelper 班级端跑起来，大约半小时。 已经在用了 课表、作业、通知、叫人、课件、成绩、灵动岛的使用说明。 负责运维 部署形态怎么选、备份与恢复、换数据库、升级与回滚。 要改代码 架构、接口、数据模型、动效层，以及版本迭代与发布流程。

它长什么样

这些图都是脚本把程序真的跑起来截的，不是示意图。采集方式见 验收与测试。

目录

章节	里面有什么	谁看
快速上手	系统要求、安装、第一次配置、发布第一条内容	第一次部署的人
应用帮助	逐个功能怎么用，以及行为上的约定（什么时段弹、谁看得见）	老师、班主任、管理员
管理运维	部署形态、Linux 运维命令、备份、换库、升级	管服务器的人
开发文档	架构、REST API、实时事件、数据模型、权限、发布流程	改代码的人
常见问题	装不上、连不上、改了不生效……	所有人

这套系统的三件事

一、老师发，教室弹。 Web 端发布的内容通过 Socket.IO 按班级房间广播，客户端与灵动岛实时更新。

二、课堂提醒有明确规则。 经典岛普通通知暂存到下课，普通叫人保留可点胶囊，紧急消息立即展开； 自定义常驻岛先显示铃铛，由用户主动查看。课堂发布紧急通知还需服务端确认。

三、离线可用。 客户端先写 IndexedDB，断网时回退缓存并在顶部提示； 恢复连接后自动重新拉取，教室网络抖一下不会让大屏变白。

关于本文档

• 文档站的源码就在仓库里（docs/），用 docfx 生成，发布在 GitHub Pages 上。 每页右下角有「在 GitHub 上编辑这一页」，发现写错或写漏可以直接改。
• 版本号取自仓库根 package.json，显示在顶栏，与 Releases 对齐。
• 想在自己机器上预览：pnpm docs:build --serve。