学生、任课关系、周次口径三处长期靠约定维持的事情,改为由数据模型保证。 学生不是账号 - 拆出独立 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 原样搬迁,历史数据不丢), 升级前请先备份。
6.4 KiB
title, description
| title | description |
|---|---|
| 安装服务端 | 用 Windows 安装包、Linux 一键脚本、Docker 或源码把 ClassHelper 服务端跑起来。 |
安装服务端
服务端是整个系统的中心:它存数据、发实时推送,并且顺带托管 Web 管理端(所以老师那一端不用单独装东西)。
四种装法按场景选,任选一种即可:
| 方式 | 适合 | 一句话 |
|---|---|---|
| Windows 安装包 | 学校机房、教师办公电脑、单机即完整系统 | 双击 exe,装完自动启动 |
| Linux 一键安装 | 学校已有 Linux 服务器 | 一条命令,带 systemd 与运维命令 |
| Docker | 云服务器、想跟别的服务共用一台机器 | docker compose up -d |
| 源码跑 | 想改代码、想先看看它长什么样 | pnpm dev |
Windows 安装包
生成安装包
安装包不入库(体积大),从 Releases 直接下载
ClassHelper 服务端-<版本>-x64-setup.exe 即可。要自己打:
pnpm dist:server # 首次会执行一次 npm install(约 2 分钟)
pnpm dist:server -- --reuse-deps # 迭代打包:复用已装依赖,跳过 npm install
产物:
| 路径 | 说明 |
|---|---|
releases/server/<版本>/安装包/ClassHelper 服务端-<版本>-x64-setup.exe |
安装程序(约 62 MB,NSIS) |
releases/server/<版本>/免安装/ |
免安装目录,拷到任意 Windows x64 机器即可跑 |
包内自带 Node 运行时、后端产物、Web 管理端产物、生产依赖、迁移 SQL、随机 JWT_SECRET 的 .env
与启停脚本。目标机器不需要预先安装 Node.js。
安装与启动
双击安装程序即可,不需要管理员权限(当前用户级安装)。
- 安装目录:
%LOCALAPPDATA%\Programs\ClassHelperServer - 静默安装:
"ClassHelper 服务端-<版本>-x64-setup.exe" /S - 开始菜单:启动服务 / 停止服务 / 重启服务 / 打开管理端 / 使用说明 / 卸载
- 自动加入当前用户开机自启
装完服务会自动启动并完成首次初始化:数据库为空则执行随包迁移建表 → 创建管理员账号 →
http://127.0.0.1:4000/ 就是 Web 管理端。
常用脚本(都在安装目录里):
start.cmd :: 启动并等待就绪(已在运行则直接返回)
stop.cmd :: 按 PID 精确停止
restart.cmd :: 重启
status.cmd :: 查看状态与 HTTP 探针结果
机房主机这种无人值守的机器,建议以管理员身份跑一次 install-service.cmd,
把服务注册成开机启动的计划任务(比注册表 Run 更稳):
install-service.cmd :: schtasks /Create /SC ONSTART /RL HIGHEST
uninstall-service.cmd :: 删除计划任务
安装目录结构与配置见生产部署指南; 安装程序里的默认管理员口令第一次登录后必须改掉。
Linux 一键安装
从 Release 下载 classhelper-server-linux-x64-<版本>.tar.gz(以及旁边的 .sha256),连同
install.sh 一起拷到服务器:
scp releases/server/<版本>/linux-x64/classhelper-server-linux-x64-*.tar.gz \
install.sh verify-linux.sh root@<主机>:/tmp/
ssh root@<主机> 'bash /tmp/install.sh --check' # 先体检,不改任何东西
ssh root@<主机> "printf '%s\n' '<管理员密码>' | bash /tmp/install.sh --yes --admin-password-stdin \
--package /tmp/classhelper-server-linux-x64-*.tar.gz"
安装器会装好内置 Node、把程序放到 /opt/classhelper、写好 systemd 单元、
把 classhelper 运维命令软链到 /usr/local/bin/。之后:
classhelper status # 服务状态
classhelper doctor # 一整套自检(配置软链、权限、依赖完整性…)
classhelper backup # 立即备份
classhelper upgrade # 升级到最新 Release(自动校验 sha256)
完整的目录布局、配置项、升级回滚、反向代理与故障排查见 Linux 部署与运维。
Docker
cd deploy
cp .env.example .env # 至少改 JWT_SECRET
docker compose up -d # 默认 SQLite 单容器,数据卷挂在本机
要 MySQL 就用 docker-compose.yml(带一个 MySQL 服务),只想要单容器 SQLite 用
docker-compose.sqlite.yml。细节见生产部署指南。
从源码跑(开发模式)
想改代码或只想先看看,用这条路。需要 Node ≥ 20.19 与 pnpm 11。
pnpm install
cp packages/server/.env.example packages/server/.env # 至少改 JWT_SECRET
pnpm db:generate
pnpm --filter @classhelper/server db:deploy # 应用数据库迁移
pnpm build:shared # 必须先构建 shared,否则后面会 ERR_MODULE_NOT_FOUND
pnpm db:seed # 写演示数据(会清空业务表)
pnpm dev # 后端 4000 + Web 端 5173 一起起
演示账号见 README 的「默认账号与种子数据」; 演示口令只用于本地开发,别带到真实环境。
| 端口 | 用途 |
|---|---|
| 4000 | 后端 REST + Socket.IO + (构建后)Web 管理端静态托管 |
| 5173 | Web 管理端开发服务器(/api、/socket.io 代理到 4000) |
| 5174 | 桌面客户端渲染进程开发服务器 |
改动
packages/shared之后必须pnpm build:shared(或让它跑着 watch)—— 三端都从它的dist导入。
装完之后
打开 http://<服务器地址>:4000/,用管理员账号登录。下一页:
认识 Web 管理端。