diff --git a/.Screenshots/ExamPage.jpg b/.Screenshots/ExamPage.jpg deleted file mode 100644 index 12cda8d..0000000 Binary files a/.Screenshots/ExamPage.jpg and /dev/null differ diff --git a/.Screenshots/HomePage.png b/.Screenshots/HomePage.png new file mode 100644 index 0000000..d676681 Binary files /dev/null and b/.Screenshots/HomePage.png differ diff --git a/.Screenshots/InfoPage.png b/.Screenshots/InfoPage.png new file mode 100644 index 0000000..10af6c5 Binary files /dev/null and b/.Screenshots/InfoPage.png differ diff --git a/.Screenshots/WelcomePage.jpg b/.Screenshots/WelcomePage.jpg deleted file mode 100644 index cf889dd..0000000 Binary files a/.Screenshots/WelcomePage.jpg and /dev/null differ diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml index dfaa5d1..877f3db 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.yml +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -1,5 +1,5 @@ name: Bug 反馈 -description: 在使用考试看板 Next 的过程中遇到了 Bug。 +description: 在使用考试看板 Next 的过程中遇到了 Bug 。 title: (在这里输入你的标题) labels: ['Bug', '未阅读'] body: @@ -9,9 +9,10 @@ body: 感谢您进行 Bug 反馈。请在上面的文本框⬆️起一个能够清晰描述您的问题的标题,便于开发者解决您的问题。 > [!important] - > 重要:如果要提出**多个 Bug**,请为每一个 Bug 开一个单独的 issue。 + > + > 如果要提出**多个 Bug **,请为每一个 Bug 开一个单独的 issue。 > - > 如果您不知道如何有效、精准地表述,我们建议您先阅读《提问的智慧》([链接](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md))。 + > 如果您不知道如何有效、精准地表述,建议先阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。 - type: checkboxes id: checklist @@ -19,7 +20,7 @@ body: label: 检查清单 description: 在开始反馈这个问题之前,请先检查: options: - - label: 我已更新到最新版 ![最新的版本号](https://img.shields.io/github/v/release/ProjectCampus-CH/dsz-exam-showboard-next?include_prereleases&style=flat-square&label=) ,并看过[最新提交](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/dev/),确认这一 Bug 还没有修复。 + - label: 我已更新到最新版 ![最新的版本号](https://img.shields.io/github/v/release/ProjectCampus-CH/dsz-exam-showboard-next?include_prereleases&style=flat) ,并看过[最新提交](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/dev/),确认这一 Bug 还没有修复。 required: true - label: 我已在 [Issues](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues?q=label%3ABug) 中检索,确认这一 Bug 未被提交过。 required: true @@ -50,7 +51,7 @@ body: attributes: label: 重现步骤 description: | - 详细描述要怎么操作才能再次触发这个 Bug。 + 详细描述怎么操作能再次触发这个 Bug 。 placeholder: | 1. 首先…… 2. 然后…… @@ -61,14 +62,14 @@ body: id: stacktrace attributes: label: 堆栈跟踪(可选) - description: 如果在遇到这个 Bug 时发生了崩溃(弹出崩溃提示),或者产生了错误日志,请将产生的堆栈跟踪信息粘贴到此处,便于开发者定位 Bug。 + description: 如果在遇到这个 Bug 时发生了崩溃(弹出崩溃提示),或者产生了错误日志,请将产生的堆栈跟踪信息粘贴到此处,便于开发者定位 Bug 。 render: shell - type: input id: app_version attributes: label: 应用版本 description: 您当前使用的考试看板 Next 版本号,可以在【关于】中查看。 - placeholder: 如:1.1.1 + placeholder: 如:1.2.0 validations: required: true - type: input @@ -86,4 +87,4 @@ body: description: 回顾您的回答 options: - label: 我认为上述的描述已经足以详细,以允许开发人员能复现该问题。如果我的 issue 没有按照上述的要求填写,可能会被无条件关闭。 - required: true + required: true \ No newline at end of file diff --git a/.github/workflows/readme-contributors.yml b/.github/workflows/readme-contributors.yml new file mode 100644 index 0000000..bd81ea8 --- /dev/null +++ b/.github/workflows/readme-contributors.yml @@ -0,0 +1,17 @@ +on: + push: + branches: + - master + +jobs: + contrib-readme-job: + runs-on: ubuntu-latest + name: A job to automate contrib in readme + permissions: + contents: write + pull-requests: write + steps: + - name: Contribute List + uses: akhilmhdh/contributors-readme-action@v2.3.10 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index 0fc75bc..b8ec758 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,30 @@
-# ExamShowboard-Next + -> 考试看板 Next —— 下一代考试看板 +# ExamShowboard-Next(下一代考试看板) + +![HomePage](/.Screenshots/HomePage.png) +![InfoPage](/.Screenshots/InfoPage.png) + +[![stars](https://img.shields.io/github/stars/ProjectCampus-CH/dsz-exam-showboard-next?label=Stars)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/stargazers) +[![forks](https://img.shields.io/github/forks/ProjectCampus-CH/dsz-exam-showboard-next?label=Forks)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/forks) +[![Watchers](https://img.shields.io/github/watchers/ProjectCampus-CH/dsz-exam-showboard-next?style=social)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/watchers) +[![Downloads](https://img.shields.io/github/downloads/ProjectCampus-CH/dsz-exam-showboard-next/total?style=social&label=Downloads&logo=github)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/releases) +[![GitHub Issues](https://img.shields.io/github/issues-search/ProjectCampus-CH/dsz-exam-showboard-next?query=is%3Aopen&style=flat&logo=github&label=Issues&color=%233fb950)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues) +[![GitHub Discussions](https://img.shields.io/github/discussions/ProjectCampus-CH/dsz-exam-showboard-next?style=flat&logo=Github&label=Discussions)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/discussions) +[![Created At](https://img.shields.io/github/created-at/ProjectCampus-CH/dsz-exam-showboard-next)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next) +[![Github Last Commit](https://img.shields.io/github/last-commit/ProjectCampus-CH/dsz-exam-showboard-next)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/master) +[![GitHub Language Count](https://img.shields.io/github/languages/count/ProjectCampus-CH/dsz-exam-showboard-next)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next) +[![GitHub Top Language](https://img.shields.io/github/languages/top/ProjectCampus-CH/dsz-exam-showboard-next)](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next) -[![stars](https://img.shields.io/github/stars/MKStoler4096/dsz-exam-showboard-next?label=Stars)](https://github.com/MKStoler4096/dsz-exam-showboard-next/stargazers) -[![forks](https://img.shields.io/github/forks/MKStoler4096/dsz-exam-showboard-next?label=Forks)](https://github.com/MKStoler4096/dsz-exam-showboard-next/forks) -[![Watchers](https://img.shields.io/github/watchers/MKStoler4096/dsz-exam-showboard-next?style=social)](https://github.com/MKStoler4096/dsz-exam-showboard-next/watchers) -[![Downloads](https://img.shields.io/github/downloads/MKStoler4096/dsz-exam-showboard-next/total?style=social&label=Downloads&logo=github)](https://github.com/MKStoler4096/dsz-exam-showboard-next/releases) -[![GitHub Issues](https://img.shields.io/github/issues-search/MKStoler4096/dsz-exam-showboard-next?query=is%3Aopen&style=social-square&logo=github&label=Issues&color=%233fb950)](https://github.com/MKStoler4096/dsz-exam-showboard-next/issues) -[![GitHub Discussions](https://img.shields.io/github/discussions/MKStoler4096/dsz-exam-showboard-next?style=flat&logo=Github&label=Discussions)](https://github.com/MKStoler4096/dsz-exam-showboard-next/discussions) -[![Created At](https://img.shields.io/github/created-at/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next) -[![Github Last Commit](https://img.shields.io/github/last-commit/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/master) -[![GitHub Language Count](https://img.shields.io/github/languages/count/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next) -[![GitHub Top Language](https://img.shields.io/github/languages/top/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next) [![LICENSE](https://img.shields.io/badge/License-GPL--3.0-red.svg 'LICENSE')](LICENSE) [![QQ群](https://img.shields.io/badge/-QQ%E7%BE%A4%EF%BD%9C901670561-blue?style=flat&logo=TencentQQ&logoColor=white)](https://qm.qq.com/q/zDiEipHsaI) 一款显示当前时间与考试详细信息的看板类软件 -| 下载 | [Releases](https://github.com/MKStoler4096/dsz-exam-showboard-next/releases) | [Actions](https://github.com/MKStoler4096/dsz-exam-showboard-next/actions) | -| ---- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| 下载 | [Releases](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/releases) | [Actions](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/actions) | +| - | - | - | ![WelcomePage](/.Screenshots/WelcomePage.jpg) ![ExamPage](/.Screenshots/ExamPage.jpg) @@ -28,16 +32,15 @@
> [!tip] -> -> **本软件使用`Vue` + `TypeScript` + `JavaScript`制作,使用`Node.js` + `Electron`完善系统级功能并打包。** +> **本软件使用 `Vue` + `TypeScript` + `JavaScript` 制作,使用 `Node.js` + `Electron` 完善系统级功能并打包。** ## 功能 -- 起始页展示`打开配置`、`直接进入看板`按钮 +- 起始页展示 `打开配置` 、 `直接进入看板` 按钮 - 看板页面 - - 上方展示`考试标题`、`信息` - - 左侧展示`当前时间`、`当前科目`、`考试时间`、`考试状态` - - 右侧展示考试科目列表,包括`科目`、`开始`、`结束`、`状态` + - 上方展示 `考试标题` 、 `信息` + - 左侧展示 `当前时间` 、 `当前科目` 、 `考试时间` 、 `考试状态` + - 右侧展示考试科目列表,包括 `科目` 、 `开始` 、 `结束` 、 `状态` - 考试结束前15分钟黄字提醒 - 集控功能(早期测试) @@ -45,57 +48,75 @@ - 下载安装程序并运行 -默认安装在`AppData\Local\Programs\dsz-exam-showboard` +默认安装路径 `AppData\Local\Programs\dsz-exam-showboard` -- 编写`json`配置文件 +- 编写 `json` 配置文件 -新建文件`exam_config.json`,模板如下 +新建文件 `exam_config.json` ,模板如下 ```json { "examName": "考试名称", "message": "信息", + "room": "考场号", "examInfos": [ { "name": "科目", - "start": "2024-10-01T07:00:00", - "end": "2024-10-01T08:00:00" + "start": "2024-12-01T07:00:00", + "end": "2024-12-01T08:00:00" }, { - "name": "科目", - "start": "2024-10-01T09:00:00", - "end": "2024-10-01T10:00:00" + "name": "科目/科目", + "start": "2024-12-01T09:00:00", + "end": "2024-12-01T10:00:00" } ] } ``` -- 打开软件,进入起始页面,点击`打开配置`按钮,选择配置文件,下次可点击`直接进入看板`按钮,将继续使用上次加载的配置。 +> [!tip] +> +> `message` 与 `room` 为选填 +> +> 如果有两个以"/"分隔的科目可以自动转化为双行显示 -- 集控 +- 打开软件,进入起始页面,点击 `打开配置` 按钮,选择配置文件 +- 或使用集控(仿照 [`ClassIsland` 集控使用方法](https://docs.classisland.tech/management/tutorial-create-management-config.html)) + - 新建 GitHub 公开存储仓库 + - 上传上面提到的 `exam_config.json` 文件 + - 复制 `Raw` 直链粘贴到应用`请求地址`文本框并保存 -仿照 `ClassIsland` 的集控方法,把上面提到的 `exam_config.json` 传上去,获得 `raw` 直链粘贴回文本框并保存即可。 +> [!tip] +> +> 可以在 `Raw 文件` 前加上镜像源,如 +> +>``` +>https://github.moeyy.xyz/https://raw.githubusercontent.com/{owner}/{repo}/refs/heads/main/exam_config.json +>``` + +- 点击`请求配置`加载配置文件并进入看板(下次可直接点击`直接进入看板`加载上次配置文件) ## 遇到问题 -💡 如果您遇到`Bug`,或需要提出`优化`建议或新的`功能`,请提交[`Issues`](https://github.com/MKStoler4096/dsz-exam-showboard-next/issues)或在[`Discussions`](https://github.com/MKStoler4096/dsz-exam-showboard-next/discussions)中讨论。 +💡 如果您遇到 `Bug` ,或需要提出`优化`建议或新的`功能`,请提交 [`Issues`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues) 或在 [`Discussions`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/discussions) 中讨论。 -👥 您也可以加入[`QQ群|901670561`](https://qm.qq.com/q/zDiEipHsaI)获取帮助或交流讨论。 +👥 您也可以加入 [`QQ群|901670561`](https://qm.qq.com/q/zDiEipHsaI)获取帮助或交流讨论。 -🛠️ 欢迎为本软件进行改进或编写新功能提交[`Pull Request`](https://github.com/MKStoler4096/dsz-exam-showboard-next/pulls) +🛠️ 欢迎为本软件进行改进或编写新功能提交 [`Pull Request`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/pulls) ## 开发 ### 推荐开发环境 - [VSCode](https://code.visualstudio.com/) -- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) -- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) -- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + - [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) -> [!IMPORTANT] +> [!Caution] > -> **必须使用Yarn包管理。Node版本要求为20。** +> **必须使用 Yarn 包管理。Node 版本要求为20。** + ### 工程构建 @@ -113,11 +134,11 @@ $ yarn dev $ yarn start ``` -> [!note] +> [!important] > -> **如果dev模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。build后没有此问题。** +> **如果 dev 模式页面不显示或按钮点击无效等问题,请连续刷新至少3次后再进行操作。 build 后没有此问题。** -#### 生成 +#### 构建 ```bash # For windows @@ -132,16 +153,63 @@ $ yarn build:linux ### 开发进度 -- 正在[`master`](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/master)分支上维护`1.2-Yesod`版本。 +- 正在 [`master`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/master) 分支上维护`1.2-Yesod`版本。 -- 正在[`dev`](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/dev)分支上开发`1.3-HOD`版本。 +- 正在 [`dev`](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/dev) 分支上开发`1.3-HOD`版本。 + +## 贡献者 + + + + + + + + + + + + +
+ + Jursin +
+ Jursin +
+
+ + hello8693DSZ +
+ Hello8693 +
+
+ + MKStoler4096 +
+ MKStoler +
+
+ + fhz08 +
+ fhz08 +
+
+ + wjj-8283 +
+ wjj-8283 +
+
+ ## Stars 历史 -[![Stargazers over time](https://starchart.cc/ProjectCampus-CH/exam-showboard-next.svg?variant=adaptive)](https://starchart.cc/ProjectCampus-CH/exam-showboard-next)
+[![Star 历史](https://starchart.cc/ProjectCampus-CH/dsz-exam-showboard-next.svg?variant=adaptive)](https://starchart.cc/ProjectCampus-CH/dsz-exam-showboard-next/stargazers) + 如果这个项目对您有帮助,请点亮 Star [⭐](#dsz-exam-showboard-next)
diff --git a/image/README/main.png b/image/README/main.png deleted file mode 100644 index a8dfe79..0000000 Binary files a/image/README/main.png and /dev/null differ diff --git a/image/README/view.png b/image/README/view.png deleted file mode 100644 index ef22f6e..0000000 Binary files a/image/README/view.png and /dev/null differ diff --git a/src/renderer/src/components/ExamList.vue b/src/renderer/src/components/ExamList.vue index fcd377c..46bac9b 100644 --- a/src/renderer/src/components/ExamList.vue +++ b/src/renderer/src/components/ExamList.vue @@ -1,8 +1,8 @@