Skip to content
This repository was archived by the owner on Jan 27, 2026. It is now read-only.

Commit fa8e6ca

Browse files
authored
Merge pull request #19 from PYLXU/patch-3
feat: 补充功能栏目内容,添加开始使用栏目供开发者安装参考
2 parents 6c13b41 + cdceff6 commit fa8e6ca

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,86 @@ ClassIsland 集控服务器。
66
77
## 功能
88

9+
> [!TIP]
10+
>
11+
> 您可以点击下方链接或查看 [ClassIsland 文档](https://docs.classisland.tech) 了解更多。
12+
13+
### 管理后端
14+
15+
- [x] 实例注册与获取
16+
- [x] 实例分组
17+
- [x] 上传档案
18+
19+
### 数据分发
20+
21+
- [x] 按实例与分组拼接数据
22+
- [x] 分发策略
23+
- [x] 分发设置信息
24+
- [x] 分发档案信息
25+
- [x] 使用grpc向客户端发送命令
26+
- [ ] 向客户端发送提醒
27+
- [ ] 通知客户端更新数据
28+
29+
### API
30+
31+
- [x] API返回分页
32+
33+
### WebUI
34+
- [x] 批量创建对象
35+
- [x] 管理并分组实例
36+
- [x] 管理并分组档案(课表、时间表、科目)信息
37+
- [x] 上传档案信息
38+
- [ ] 从表格导入课表
39+
- [ ] 管理并分组策略
40+
- [x] 管理并分组默认设置
41+
42+
### 用户
43+
- [x] 用户创建与管理
44+
- [ ] 用户鉴权
45+
- [ ] 用户角色(管理员,教师,访客等)
46+
47+
## 开始使用(预览)
48+
49+
**请确保您的设备满足以下推荐需求:**
50+
51+
- Windows / Linux 系统
52+
- [Windows .NET 8.0 桌面运行时](https://dotnet.microsoft.com/zh-cn/download/dotnet/thank-you/runtime-desktop-8.0.7-windows-x64-installer)
53+
- [Linux .NET 8.0 桌面运行时](https://learn.microsoft.com/zh-cn/dotnet/core/install/linux)
54+
55+
> [!IMPORTANT]
56+
>
57+
> **本版本为预览版,仅用于测试和开发环境,请勿在生产环境中使用。**
58+
> 如您是普通用户,建议等待官方发布构建版本。
59+
60+
---
61+
62+
对于开发者或高级用户,您可以从以下渠道获取本软件的预览版本:
63+
64+
### 获取安装包
65+
66+
1. 访问 [GitHub Actions - ManagementServer](https://github.com/ClassIsland/ManagementServer/actions) 页面
67+
2. 选择最新左侧带对勾的Action进入
68+
3. 在 “Summayr” 底部下载适用于您平台的压缩包文件
69+
70+
### 安装步骤
71+
72+
1. 将压缩包解压到一个**独立的文件夹**(路径中请勿包含中文或特殊字符)
73+
> ⚠️ 请勿将程序解压至网盘同步目录、【下载】文件夹等可能存在访问限制的路径,否则可能导致**文件读写失败、配置丢失**等问题。
74+
2.`data/appsettings.example.json` 文件复制为 `appsettings.json`(位于程序主目录下)
75+
3. 创建数据库,并记录数据库地址、用户名、密码及数据库名称
76+
4. 编辑 `appsettings.json` 文件:
77+
- 修改 `ConnectionStrings.Production` 键值:
78+
1. 替换 `{Your Host}` 为数据库服务器地址(无需端口,如 `localhost`
79+
2. 替换 `{User Id}` 为数据库用户名
80+
3. 替换 `{Your Password}` 为数据库密码
81+
4. 替换 `classisland_management` 为实际使用的数据库名
82+
- 添加/修改键 `DatabaseType``mysql`(目前仅支持 MySQL)
83+
5. 如果您是 Windows 用户,可直接运行 `.ps1` 启动脚本启动服务
84+
6. 如果您是 Linux 用户,并希望长期运行服务,可参考[此文档](https://blog.csdn.net/Pan_peter/article/details/128875714)进行配置
85+
86+
> [!NOTE]
87+
> 如果您遇到任何问题,请前往 [ClassIsland.ManagementServer GitHub 仓库](https://github.com/ClassIsland/ManagementServer) 提交 issue 或查阅相关讨论内容。
88+
89+
990
**🚧本项目还在开发中**
1091

0 commit comments

Comments
 (0)