Files
ClassHelper/docs/get-started/client.md
T
LoveChengke 9d5ac7adf9 feat(shared,server,web,client,plugin)!: 角色与权限重构 + 学期周次 + 课表方向反转(1.2.0)
学生、任课关系、周次口径三处长期靠约定维持的事情,改为由数据模型保证。

学生不是账号
- 拆出独立 Student 表,没有 passwordHash / role / 任何登录字段
- 「学生不能登录」由表结构保证,不再靠「登录前判 role 再 403」的代码分支
- 三张个人数据表外键 userId → studentId;删掉 Enrollment 与 ClassTeacher
- 学生一律称「学号」、教师一律称「工号」,「学生账号」这个概念消失

任课关系唯一来源 = Course(班级 + 科目 + 教师)
- 班主任 = Class.teacherId,科任 = Course.teacherId,同一人两处指向同一账号、不重复建号
- 作业与成绩按科目再收一道:挂科目只由该科任课老师改,没挂科目归班主任 / 管理员
- 新增「任课教师分配」与「班级教师批量导入」(带「使用工号匹配」开关)

成绩与名单
- 成绩等级:百分制 / 等级制 A·B·C·D / 自定义,支持单个与批量改等级
- 按学号查成绩明细(教师端 + 班级端 + 设备令牌),受按班开关控制
- 调班 / 转出(单个与批量)+ 可查历史;学号不变、历史作业成绩留原归属
- 毕业归档页(按年度记录毕业班级 / 毕业生 / 转出学生 / 该届通知与作业)
- 学年升级(未毕业不归档、数据沿用);班级称呼改为「2026级1班」

ClassHelper 班级端在线状态
- Web 端显示 班级 / 设备名 / 设备号 / 在线离线 / 最后在线 / 最后心跳
- lastHeartbeatAt 驱动 60 秒在线窗口,与只表示「带状态上报」的 lastSeenAt 分开

学期周次
- 新增 TermWeek(classId 空串 = 全校默认),管理员可用日期范围选择器逐周配置
- 一键按开学日期生成整学期;联网拉取调休建议(只给建议、不改数据,无外网失败属正常)
- 改周次后随课表下发给教室的 ClassHelper 班级端

课表方向反转
- 主方向改为「服务端 → 教室」自动下发;教室不再自动回传
- 取教室课表改为手动动作(点击前弹警告),插件按待办标记在下一次心跳补报

改名
- 班级小助手 → ClassHelper:界面、窗口标题、托盘、灵动岛、EXE、安装包、
  安装目录、systemd 描述、插件清单与设置页、官网、文档站、README

BREAKING CHANGE: 产品名与 EXE 名变更(班级小助手.exe → ClassHelper.exe),
安装目录随之改变,不支持覆盖安装,需先卸载旧版。
服务端首次启动会自动应用 6 个数据库迁移(学生行按 id 原样搬迁,历史数据不丢),
升级前请先备份。
2026-10-06 19:41:18 +08:00

4.9 KiB
Raw Blame History

title, description
title description
装 ClassHelper 班级端 在教室机器上安装 ClassHelper桌面客户端,用班级码登录,并第一次跑通实时通知。

装 ClassHelper 班级端

桌面客户端装在教室的那台机器上(教室大屏、讲台电脑)。它是学生看课表作业的地方, 也是「消息到达的第一现场」—— 灵动岛就长在这一端。

1. 下载与安装

从 Releases 取:

产物 用途
ClassHelper-<版本>-x64-setup.exe 安装包(约 98 MB),装到本机并建快捷方式
ClassHelper-<版本>-x64-portable.exe 单文件便携版,双击即用,适合不改动机房机器

要自己打:

pnpm dist:win     # 安装包 + 便携版;只要免安装目录用 pnpm dist:dir

装不上 / 双击没反应 / 一闪就没(报 0x80000003)通常不是产物坏了,而是交付物被打了 Low 完整性标签。打包脚本收尾已自动修正;从 Release 下载的包不受影响。 另外:关窗是隐藏到托盘,进程还在,再双击会因单实例锁秒退 —— 先从托盘退出。

2. 登录

打开客户端 → 填三项:

字段 填什么
服务器地址 http://<服务器IP>:4000(局域网用内网 IP,别用 localhost)
班级码 管理员在「班级管理」里给这个班设的码,例如 G203
班级密码 建班级时设的密码

旁边的「测试连接」可以先确认网络通。已登录过但服务器暂时不可达时,登录页会给一个「离线进入」—— 进去后看到的是上次缓存的课表 / 作业 / 通知(顶部会标「离线缓存」),网络恢复后自动刷新。

客户端没有改密码入口,这是刻意的:教室机器上误改班级密码会把别的机器锁在门外。 班级密码由管理员在 Web 端「班级管理 → 修改班级账号」维护。

3. 首次启动的六步向导

第一次启动会在登录页上自动弹一个向导:欢迎 → 连接服务器 → 登录班级 → 登录之后(主界面与离线缓存)→ 灵动岛提醒 → 完成。走完或跳过都会记为已完成,之后不再自动弹。

想重看:登录页的**「查看使用引导」**,或进去之后 设置 → 通用 → 使用引导。

4. 认一认主界面

左侧是四个一级项(课表 / 作业 / 通知 / 成绩)加上一个可展开的设置分组, 顶部汉堡按钮把整栏收成 64px 的图标导轨(折叠状态会记住)。「通知」项上有未读红点。

页面 一句话
课表 周视图 + 「今天」时间轴(大时钟 / 正在上什么 / 下一节)
作业 看板模式(按科目卡片、可全屏)/ 列表模式;教室机器还能录入作业
通知 未读红点、优先级标签、点开自动标为已读
成绩 班级账号看到的是全班总览(表格 + 柱状图 + 等级分布)
设置 通用 / 外观 / 灵动岛 / 提醒 / 账号 / 关于,六个子页

细节见应用帮助。

5. 在教室机器上把它调成"能看"的样子

教室大屏的观看距离和角度跟办公桌不一样,装完建议顺手做三件事:

  1. 开全屏作业看板 —— 作业页「全屏看板」,按屏幕尺寸自动排版,整个屏幕刚好放得下、不用滚动。
  2. 调灵动岛 —— 设置 → 灵动岛:高度、宽度、字号、主题色、停靠位置、视觉风格。 讲台机器上通常把字号调大一点、位置放到顶部居中。 触摸屏(希沃白板等)走的是另一套命中逻辑,客户端会自动识别,不用手动开。
  3. 选提醒弹在哪端 —— 设置 → 提醒:ClassHelper 与 ClassIsland 都弹 / 只在客户端 / 只在 ClassIsland。 这个选择会同步到班级记录,服务端据此决定要不要推 ClassIsland。

6. 确认实时链路是通的

在 Web 管理端给这个班发一条普通通知,教室机器上应该几秒内出现灵动岛胶囊。如果没有:

  • 客户端顶栏的实时通道状态是不是"已连接"?
  • 现在是上课时段吗?上课时段的普通通知只进队列、下课才弹,这是设计行为,不是故障。
  • 服务器与教室机器之间能互相 ping 通吗?防火墙放行 4000 了吗?

排查清单见常见问题。

下一步(可选):接入 ClassIsland。