Files
ClassHelper/docs/get-started/requirements.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.3 KiB
Raw Blame History

title, description
title description
系统要求 ClassHelper 服务端、Web 管理端、桌面客户端的运行环境与网络要求。

系统要求

服务端

服务端的安装包自带 Node 运行时,目标机器不需要另外装 Node.js,也不需要数据库软件 (默认用内嵌的 SQLite)。

项目 要求
操作系统 Windows 10 / 11 / Server 2016+(x64);Linux(glibc 2.28+,见下);Docker
内存 512 MB 起步,2 GB 以上更稳(Node + SQLite 常驻约 120–200 MB)
磁盘 程序约 340 MB(免安装目录)/ 安装后约 400 MB;数据按班级量增长,通常几十 MB
CPU 任意 x64;不需要独显

Linux 的 glibc 要求:内置的 Node 官方 linux-x64 构建要求 glibc ≥ 2.28。 CentOS 7 是 2.17,一键安装器会检测并自动换成 -glibc-217 变体(尽力而为,未做长期验证)。 判据:

ldd --version | head -1

外网:服务端只在「检查更新」时访问 GitHub,且失败是设计内的结果(返回"查不到",不报错)。 内网机器可以完全不连通外网。

Web 管理端

不需要安装,用浏览器打开服务端地址即可。

项目 要求
浏览器 Chrome / Edge 100+、Firefox 100+、Safari 15+(要支持 CSS 容器查询)
屏幕 桌面 1280×720 以上;手机(≤768px)有一套独立的抽屉式布局,同样可用
安装 PWA 手机 / 桌面 Chrome 里「添加到主屏幕」可当 App 用(需要 HTTPS 或 localhost)

桌面客户端(ClassHelper 班级端 / 教室机器)

项目 要求
操作系统 Windows 10 / 11(x64)
内存 4 GB 以上(Electron 常驻约 250–400 MB)
磁盘 安装后约 330 MB
显卡 有 D3D11 即可;希沃一体机、老显卡、虚拟机都做过兼容(没有裁剪 GPU 回退组件)
触摸屏 支持,会自动进入触摸模式(希沃白板等)

客户端只有 Windows 版。Linux / macOS 上目前只能用 Web 管理端。

网络

三端的通信都指向服务端的 HTTP 端口(默认 4000),其中:

  • REST 接口:/api/*
  • 实时推送(Socket.IO):/socket.io/
  • Web 管理端静态资源:/(由服务端托管)
场景 要做什么
只在服务器本机用 什么都不用做,http://127.0.0.1:4000
教室机器 / 老师电脑也要用 客户端与管理端填服务器的局域网 IP(如 http://192.168.1.10:4000),防火墙放行 4000
公网访问 前面加 Nginx / Caddy 反代并启用 HTTPS,见生产部署指南

别用代理。本机自测时用 curl.exe --noproxy '*',PowerShell 用 -NoProxy; 教室机器上如果开了系统代理,填服务端地址后可能拿到代理返回的 404。插件里对本地 / 内网地址做了强制直连, 但浏览器与客户端本身不会绕过。

卸载 / 重置

  • 服务端:开始菜单 → 卸载。卸载会保留数据库(data 目录改名为 data.backup)。
  • 客户端:从托盘退出后卸载;重置配置删 %APPDATA%\class-helper(或客户端「关于」页显示的数据目录)。

下一步:安装服务端。