mirror of
https://github.com/ExamAware/ExamSchedule.git
synced 2025-04-29 19:16:33 +00:00
docs: 更新README以添加本地启动和在线部署说明
This commit is contained in:
parent
6ce390c321
commit
2054fd43ce
69
README.md
69
README.md
@ -4,10 +4,73 @@ ExamShowboard的轻量级实现
|
|||||||
|
|
||||||
## 快速使用
|
## 快速使用
|
||||||
|
|
||||||
填写`exam_config.json`后,确保安装Python。然后执行:
|
### 本地启动
|
||||||
|
|
||||||
|
1. 填写 `exam_config.json` 文件,示例如下:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"examName": "2023年期末考试",
|
||||||
|
"message": "请考生遵守考场纪律,诚信考试。",
|
||||||
|
"examInfos": [
|
||||||
|
{
|
||||||
|
"name": "数学",
|
||||||
|
"start": "2023-12-01T09:00:00",
|
||||||
|
"end": "2023-12-01T11:00:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "英语",
|
||||||
|
"start": "2023-12-01T13:00:00",
|
||||||
|
"end": "2023-12-01T15:00:00"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 确保安装Python。然后执行以下命令启动本地服务器:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 -m http.server 8000
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 打开浏览器,访问 `http://localhost:8000` 即可查看考试安排。
|
||||||
|
|
||||||
|
### 在线部署
|
||||||
|
|
||||||
|
1. 将项目代码推送到GitHub仓库。
|
||||||
|
2. 在GitHub仓库中,进入 `Settings` -> `Pages`。
|
||||||
|
3. 在 `Source` 部分选择 `main` 分支并保存。
|
||||||
|
4. GitHub Pages 将会自动部署项目,稍后即可通过提供的URL访问。
|
||||||
|
|
||||||
|
## 功能说明
|
||||||
|
|
||||||
|
- 实时显示当前时间、当前考试科目、考试起止时间、剩余时间及考试状态。
|
||||||
|
- 支持全屏显示。
|
||||||
|
- 支持设置时间偏移和考场信息,并保存到浏览器Cookie中。
|
||||||
|
|
||||||
|
## 设置说明
|
||||||
|
|
||||||
|
点击设置按钮可以打开设置窗口,进行以下配置:
|
||||||
|
|
||||||
|
- **时间偏移**:用于调整显示的时间,单位为秒。
|
||||||
|
- **考场信息**:用于显示当前考场的名称。
|
||||||
|
|
||||||
|
配置完成后点击保存按钮,设置将会保存到浏览器的Cookie中,并立即生效。
|
||||||
|
|
||||||
|
## 开发说明
|
||||||
|
|
||||||
|
如需对项目进行开发,请确保安装Node.js和npm,然后执行以下命令安装依赖:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 -m http.server 8000
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
即可。
|
开发过程中可以使用以下命令启动开发服务器:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
## 贡献
|
||||||
|
|
||||||
|
欢迎提交Issue和Pull Request来贡献代码。
|
Loading…
x
Reference in New Issue
Block a user