---
title: 快速上手
description: 从零把 ClassHelper跑起来：装服务端、认管理端、建班级排课、装 ClassHelper 班级端、发第一条内容。
---

# 快速上手

ClassHelper不是一个单机软件，它由三部分组成，**必须先有服务端，管理端与客户端才有内容可看**：

| 组成部分       | 装在哪                                  | 谁用                       | 必须先装？       |
| -------------- | --------------------------------------- | -------------------------- | ---------------- |
| **服务端**     | 一台能一直开着的机器（服务器/办公电脑） | —（它同时托管 Web 管理端） | ✅ 是            |
| **Web 管理端** | 不用装 —— 浏览器打开服务端地址即可      | 老师、班主任、管理员       | 跟着服务端一起有 |
| **桌面客户端** | 教室的电脑 / 教室大屏                   | 学生看课表作业、老师录作业 | 服务端就绪之后   |

按顺序走下面这几页就行，全程大约半小时（不含下载时间）：

1. [系统要求](requirements.md) —— 先确认机器和网络够用
2. [安装服务端](server.md) —— Windows 安装包 / Linux 一键脚本 / Docker / 源码跑
3. [认识 Web 管理端](web-admin.md) —— 登录进去，认一认界面
4. [建班级、排课表](setup-class.md) —— 这是后面所有功能的前提
5. [装 ClassHelper 班级端](client.md) —— 教室机器用班级码登录
6. [发布第一条内容](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)