https://github.com/miniopensource/cims-backend
ClassIsland 集控服务器 | 基于 Python 的适用于 ClassIsland 的集控服务器
https://github.com/miniopensource/cims-backend
classisland classisland-mgmt fastapi grpc grpc-server material-ui webapp
Last synced: about 2 months ago
JSON representation
ClassIsland 集控服务器 | 基于 Python 的适用于 ClassIsland 的集控服务器
- Host: GitHub
- URL: https://github.com/miniopensource/cims-backend
- Owner: MINIOpenSource
- License: gpl-3.0
- Created: 2025-02-15T04:31:08.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-15T11:36:56.000Z (about 2 months ago)
- Last Synced: 2025-03-15T12:26:58.918Z (about 2 months ago)
- Topics: classisland, classisland-mgmt, fastapi, grpc, grpc-server, material-ui, webapp
- Language: Python
- Homepage:
- Size: 387 KB
- Stars: 29
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 基于 Python 的适用于 [ClassIsland](https://github.com/classisland/classisland) 的集控服务器
[加入讨论区](https://qm.qq.com/ez2uhHJv2w)
集控服务器分为三个部分，分别是[`api`](./ManagementServer/api.py)[`command`](./ManagementServer/command.py)[`gRPC`](./ManagementServer/gRPC.py)，分别用于：
| 组件 | [`api`](./ManagementServer/api.py) | [`command`](./ManagementServer/command.py) | [`gRPC`](./ManagementServer/gRPC.py) |
|----|--------------------------------------|--------------------------------------------|--------------------------------------|
| 用途 | 向客户端分发配置文件 | 通过API以集控服务器为中介获取客户端状态、向客户端发送指令 | 与客户端建立gRPC链接 |
| 端口 | [50050](http://127.0.0.1:50050/docs) | [50052](http://127.0.0.1:50052/docs) | 50051 |
## *实验性* 快速部署（适用于 Linux 平台）:
```bash
bash -c "$(curl -sSL raw.githubusercontent.com/MINIOpenSource/CIMS-backend/main/install.sh)" && cd CIMS/backend && source venv/bin/activate && python CIMS.py
```
## 如何使用？
以下是使用 ClassIsland 集控服务器的步骤：
1. **环境准备**:
* **Python:** 确保你的系统已安装 Python 3.8+，推荐 Python 3.12+，推荐自行编译完整的 Python 3.12 & OpenSSL 3 环境。
* **Node.js and npm:** 如果你需要使用 WebUI，请确保已安装 Node.js (v22+) 和 npm。
* **Git (Optional):** 如果你想从 GitHub 克隆仓库，则需要安装 Git。
2. **克隆代码:**
```bash
git clone https://github.com/kaokao221/ClassIslandManagementServer.py.git
cd ClassIslandManagementServer.py
```
* 如果你不使用 Git，可以下载 ZIP 压缩包并解压。
3. **创建 venv 并安装依赖:**
```bash
python -m venv venv
./venv/Scripts/python.exe -m pip install -r requirements.txt
# Windows 环境
```
```bash
python3 -m venv venv
./venv/bin/python3 -m pip install -r requirements.txt
# Linux 环境
```
在 Linux 环境中，可能出现 venv / pip 不可用报错，请根据相关提示从命令行安装 venv 和 pip 后重新创建虚拟环境并安装依赖。
4. **构建 Protobuf 文件:**
```bash
./venv/Scripts/python.exe -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. ./Protobuf/Client/ClientCommandDeliverScReq.proto ./Protobuf/Client/ClientRegisterCsReq.proto ./Protobuf/Command/HeartBeat.proto ./Protobuf/Command/SendNotification.proto ./Protobuf/Enum/CommandTypes.proto ./Protobuf/Enum/Retcode.proto ./Protobuf/Server/ClientCommandDeliverScRsp.proto ./Protobuf/Server/ClientRegisterScRsp.proto ./Protobuf/Service/ClientCommandDeliver.proto ./Protobuf/Service/ClientRegister.proto
# Windows 环境
```
```bash
./venv/bin/python3 -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. ./Protobuf/Client/ClientCommandDeliverScReq.proto ./Protobuf/Client/ClientRegisterCsReq.proto ./Protobuf/Command/HeartBeat.proto ./Protobuf/Command/SendNotification.proto ./Protobuf/Enum/CommandTypes.proto ./Protobuf/Enum/Retcode.proto ./Protobuf/Server/ClientCommandDeliverScRsp.proto ./Protobuf/Server/ClientRegisterScRsp.proto ./Protobuf/Service/ClientCommandDeliver.proto ./Protobuf/Service/ClientRegister.proto
# Linux 环境
```
这将会构建 `.proto` 文件生成对应的 Python 代码，以用于 gRPC 通信。
5. **启动服务器:**
* **使用 `CIMS.py` :**
> 第一次启动时，会引导配置一些基础信息
```bash
./venv/Scripts/python.exe CIMS.py
# Windows 环境
```
```bash
./venv/bin/python3 CIMS.py
# Linux 环境
```
生成集控预设文件（`ManagementPreset.json`）：
```bash
./venv/Scripts/python.exe CIMS.py -g
# Windows 环境
```
```bash
./venv/bin/python3 CIMS.py -g
# Linux 环境
```
6. **访问 API:**
* 你可以在浏览器中访问 `http://127.0.0.1:50050/docs` (或你设置的端口)查看 API 文档.
> ## 注意
> 目前所有的 README Guide 和 start.py 都是在 Windows 环境开发的，在 Linux 环境下已经有生产部署的先例，但在出现意料之外的问题时，还请在 commit 中提供更多诊断信息，谢谢！
## 功能清单
## Star 历史
[](https://starchart.cc/kaokao221/ClassIslandManagementServer.py)