LoveChengke
b7cdc7c9ea
背景：用户报「下发锁屏等等指令不生效」。先把服务端那条链路单独验了一遍
（模拟客户端：登记 → 下发 → 心跳带回 → 设备列表可见 → 回执 → 清除），**整条是通的**；
真正的问题在两处。
客户端：执行失败会谎报成功
- `spawn` 找不到可执行文件 / 没权限时**不抛异常**，而是在下一个 tick 发一个异步 `error` 事件 ——
只包 `try/catch` 抓不到，代码一路走到 `return { ok: true }`，回执写着「已下达系统命令」，
Web 端看起来一切正常而机器纹丝不动
- 现在等一个 200ms 的窗口确认没有立刻报错，失败如实回执（`client-agent.ts` 的 `executeCommand`）
Web 端：点了没生效，界面上什么都不说
- 一条命令被**取消 / 过期**之后就从 `pendingCommand` 里消失，页面留白 ——
而最常见的两种"没反应"恰恰是「本机没人确认（客户端 60 秒自动按取消）」与「下达时机器离线」
- `GET /clients/devices` 增加 `lastCommand`（最近一条，不论状态）；
「客户端」页的设备表多一列「上次指令」，由 `commandStateText()` 翻成一句人话
（已执行 / 本机用户取消 / 已过期 —— 下达时机器不在线 / 待执行）
- 下发成功的提示补上「60 秒内没人点确认就按取消处理」
文档
- AGENTS.md §5 第 69 条记下这两条，并写明排查同类反馈的顺序：**先看那台机器的客户端版本是否 ≥ 1.3.0**
（远控命令的处理 `client-agent.ts` 是 1.3.0 才有的，旧客户端连心跳都不发）
- docs/reference.md 4.15 的表格补上「二次确认」的准确口径与新增的「上次指令」列
验收：`lint` / `typecheck` / `check:icons` / `docs:check` 全绿；
后端端到端 **247/247**、联动链路 **44/44**、插件静态契约 **76/76**、
Web 真实点击 **34/34**、客户端冒烟 **90/90**；
远控链路另用模拟客户端跑通，并确认新增的「上次指令」在待执行与已回执两种状态下都显示正确。
41 lines
2.5 KiB
Markdown
41 lines
2.5 KiB
Markdown
---
|
|
title: 快速上手
|
|
description: 从零把 ClassHelper跑起来：装服务端、认管理端、建班级排课、装 ClassHelper 班级端、接 ClassIsland、发第一条内容。
|
|
---
|
|
|
|
# 快速上手
|
|
|
|
ClassHelper不是一个单机软件，它由四部分组成，**必须先有服务端，其他三端才有内容可看**：
|
|
|
|
| 组成部分 | 装在哪 | 谁用 | 必须先装？ |
|
|
| ------------------------ | --------------------------------------- | -------------------------- | ---------------- |
|
|
| **服务端** | 一台能一直开着的机器（服务器/办公电脑） | —（它同时托管 Web 管理端） | ✅ 是 |
|
|
| **Web 管理端** | 不用装 —— 浏览器打开服务端地址即可 | 老师、班主任、管理员 | 跟着服务端一起有 |
|
|
| **桌面客户端** | 教室的电脑 / 教室大屏 | 学生看课表作业、老师录作业 | 服务端就绪之后 |
|
|
| **ClassIsland 联动插件** | 教室那台装了 ClassIsland 的机器 | 教室大屏播报 | 可选 |
|
|
|
|
按顺序走下面这几页就行，全程大约半小时（不含下载时间）：
|
|
|
|
1. [系统要求](requirements.md) —— 先确认机器和网络够用
|
|
2. [安装服务端](server.md) —— Windows 安装包 / Linux 一键脚本 / Docker / 源码跑
|
|
3. [认识 Web 管理端](web-admin.md) —— 登录进去，认一认界面
|
|
4. [建班级、排课表](setup-class.md) —— 这是后面所有功能的前提
|
|
5. [装 ClassHelper 班级端](client.md) —— 教室机器用班级码登录
|
|
6. [接入 ClassIsland](classisland.md) —— 让教室大屏也会弹提醒（可选）
|
|
7. [发布第一条内容](first-content.md) —— 通知 / 作业 / 叫人 / 成绩
|
|
|
|
## 只想先看看它长什么样？
|
|
|
|
不用装任何东西也能看出来它在干什么：
|
|
|
|
- **看界面**：本页文档里各处嵌的都是实机截图，比如[灵动岛](../app/island.md)、[课表](../app/schedules.md)。
|
|
- **本地跑一套演示数据**：装好 Node 20.19+ 与 pnpm 之后，
|
|
`pnpm install && pnpm build:shared && pnpm db:seed && pnpm dev` 会在本地拉起一套带演示班级的后端与
|
|
Web 管理端（详见[安装服务端](server.md#从源码跑开发模式)）。
|
|
|
|
## 装完之后呢
|
|
|
|
- 日常怎么用 → [应用帮助](../app/index.md)
|
|
- 服务器怎么维护（备份、换库、升级） → [管理运维](../management/index.md)
|
|
- 出问题了 → [常见问题](../faq.md)
|