Files
ClassHelper/docs/get-started/client.md
T
LoveChengke c7f215a09c feat(courseware,docs): 完善课件传输与岛编辑并统一全仓文档
- 增加课件上传、班级可见范围、设备补收与传输进度
- 整合自定义灵动岛编辑器和相关客户端交互
- 同步三端契约、数据库迁移、部署配置与隔离回归
- 按源码统一文档与官网说明,移除过时任务书和审查记录
- 保持产品版本为 1.4.0
2026-10-18 11:53:37 +08:00

5.0 KiB
Raw Blame History

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

装 ClassHelper 班级端

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

1. 下载与安装

从 Releases 取:

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

要自己打:

pnpm dist:win     # 安装包 + 便携版(两个都是成品,没有中间的解包目录)

双击没反应? 关窗只是隐藏到托盘,进程还在,再双击会因单实例锁秒退 —— 先从托盘右键退出。

2. 登录

打开客户端 → 填三项:

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

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

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

3. 首次启动的六步向导

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

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

4. 认一认主界面

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

页面 一句话
课表 周视图 + 「今天」时间轴(大时钟 / 正在上什么 / 下一节)
作业 看板模式(按科目卡片、可全屏)/ 列表模式;教室机器还能录入作业
课件 查看本班可见文件、下载和打开本地文件夹
通知 未读红点、优先级标签、点开自动标为已读
成绩 个人查询开启时看本班成绩,关闭后只看服务端集体分析
设置 通用 / 外观 / 灵动岛 / 提醒 / 账号 / 关于,六个子页

细节见应用帮助。

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

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

  1. 开全屏作业看板 —— 作业页「全屏看板」,按屏幕尺寸自动排版,整个屏幕刚好放得下、不用滚动。
  2. 调灵动岛 —— 设置 → 灵动岛:高度、宽度、字号、主题色、停靠位置、视觉风格。 讲台机器上通常把字号调大一点、位置放到顶部居中。 触摸屏(希沃白板等)走的是另一套命中逻辑,客户端会自动识别,不用手动开。
  3. 查看提醒规则 —— 设置 → 提醒维护本机课程等提醒设置;经典通知模式上课暂存普通消息, 自定义常驻模式提示铃铛并主动查看。规则保存在本机,服务端仍即时广播。

6. 确认实时链路是通的

在隔离测试服务中给临时验证班级发一条普通通知,经典岛课间应出现胶囊,自定义常驻岛应出现铃铛数量提示。如果没有:

  • 客户端顶栏的实时通道状态是不是"已连接"?
  • 现在是上课时段吗?经典模式普通通知上课暂存;自定义常驻模式看铃铛并主动展开。
  • 服务器与教室机器之间能互相 ping 通吗?防火墙放行 4000 了吗?

排查清单见常见问题。