mirror of
https://github.com/SECTL/SecScore.git
synced 2026-07-19 19:04:23 +08:00
7 lines
12 KiB
JSON
7 lines
12 KiB
JSON
{
|
||
"title": "SecScore",
|
||
"description": "教育积分管理软件",
|
||
"version": "v1.0.0",
|
||
"content": "<h1>SecScore</h1>\r<br>\r<br><!-- GitHub 徽章 -->\r<br><p align=\"center\">\r<br> <a href=\"https://github.com/SECTL/SecScore/releases\"><img alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/SECTL/SecScore?style=flat-square\"></a>\r<br> <a href=\"https://github.com/SECTL/SecScore/releases\"><img alt=\"Downloads\" src=\"https://img.shields.io/github/downloads/SECTL/SecScore/total?style=flat-square\"></a>\r<br> <a href=\"https://github.com/SECTL/SecScore/blob/main/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/github/license/SECTL/SecScore?style=flat-square\"></a>\r<br> <a href=\"https://github.com/SECTL/SecScore/issues\"><img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/SECTL/SecScore?style=flat-square\"></a>\r<br> <a href=\"https://github.com/SECTL/SecScore/pulls\"><img alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/SECTL/SecScore?style=flat-square\"></a>\r<br> <img alt=\"Electron\" src=\"https://img.shields.io/badge/Electron-39+-47848F?style=flat-square&logo=electron\">\r<br> <img alt=\"React\" src=\"https://img.shields.io/badge/React-19+-61DAFB?style=flat-square&logo=react\">\r<br> <img alt=\"TypeScript\" src=\"https://img.shields.io/badge/TypeScript-5+-3178C6?style=flat-square&logo=typescript\">\r<br> <img alt=\"Vite\" src=\"https://img.shields.io/badge/Vite-7+-646CFF?style=flat-square&logo=vite\">\r<br></p>\r<br>\r<br>SecScore 是一款教育积分管理软件,基于 Electron + React + TypeScript 开发,用于管理学生名单、记录加/扣分、查看排行榜与结算历史,并提供权限保护与数据备份。\r<br>\r<br><h2>主要功能</h2>\r<br>\r<br><ul><li>学生管理</li></ul>\r<br> - 添加/删除学生\r<br> - 通过 xlsx 批量导入名单(支持导入前预览与选择“姓名列”)\r<br><ul><li>积分管理</li></ul>\r<br> - 选择学生并提交加分/扣分\r<br> - 支持“预设理由”一键填充理由与分值\r<br> - 支持撤销最近的积分记录(撤销后学生积分会回滚)\r<br><ul><li>理由管理</li></ul>\r<br> - 维护“预设理由”(分类、理由内容、预设分值)\r<br><ul><li>排行榜</li></ul>\r<br> - 支持按“今天 / 本周 / 本月”查看积分变化\r<br> - 支持导出排行榜为 XLSX\r<br> - 支持查看单个学生的操作记录(文本列表)\r<br><ul><li>结算与历史</li></ul>\r<br> - “结算并重新开始”:把当前未结算记录归档为一个阶段,并将所有学生当前积分清零\r<br> - 在“结算历史”查看每个阶段的排行榜\r<br><ul><li>系统设置</li></ul>\r<br> - 主题切换\r<br> - 日志查看/导出/清空\r<br> - 数据导入/导出(JSON)\r<br> - 密码保护(管理密码 / 积分密码)与找回字符串\r<br>\r<br><h2>使用方法</h2>\r<br>\r<br><h3>1. 权限与解锁</h3>\r<br>\r<br><ul><li>右上角会显示当前权限:管理权限 / 积分权限 / 只读</li></ul>\r<br><ul><li>若设置了密码,可通过右上角“输入密码”进行解锁</li></ul>\r<br> - 管理密码:全功能(学生管理、理由管理、结算、数据管理等)\r<br> - 积分密码:仅允许积分相关操作\r<br><ul><li>点击“锁定”可切回只读状态</li></ul>\r<br><ul><li>无密码时默认视为管理权限</li></ul>\r<br>\r<br><h3>2. 学生管理(导入名单)</h3>\r<br>\r<br>入口:左侧菜单 → 学生管理 → 导入名单\r<br>\r<br><ul><li>通过 xlsx 导入</li></ul>\r<br> 1. 选择一个 <code>.xlsx</code> 文件(默认读取第一个工作表)\r<br> 2. 在预览表格里点击表头,选择“姓名列”\r<br> 3. 点击“导入”\r<br> 4. 导入完成后会提示“新增 / 跳过”数量\r<br>\r<br>建议:姓名列尽量只包含纯姓名文本;同名学生会被视为重复并跳过。\r<br>\r<br><h3>3. 积分管理(加分/扣分)</h3>\r<br>\r<br>入口:左侧菜单 → 积分管理\r<br>\r<br>1. 在“姓名”选择一个学生(支持搜索)\r<br>2. 选择“加分/扣分”,并输入分值\r<br>3. 在“理由内容”填写原因(可手动输入)\r<br>4. 点击“确认提交”\r<br>\r<br>快捷理由:\r<br>\r<br><ul><li>可在“快捷理由”下拉框中选择预设理由,一键填充理由内容/分值(优先尊重你当前是否已手动输入分值)</li></ul>\r<br>\r<br>撤销最近记录:\r<br>\r<br><ul><li>“最近记录”默认折叠,展开后可对记录点击“撤销”</li></ul>\r<br><ul><li>撤销会回滚该条记录对学生积分的影响</li></ul>\r<br>\r<br><h3>4. 排行榜与导出</h3>\r<br>\r<br>入口:左侧菜单 → 排行榜\r<br>\r<br><ul><li>可切换统计范围:今天 / 本周 / 本月</li></ul>\r<br><ul><li>点击“导出 XLSX”可导出当前排行榜</li></ul>\r<br><ul><li>点击某个学生的“查看”可打开该学生的操作记录</li></ul>\r<br>\r<br><h3>5. 结算与数据备份</h3>\r<br>\r<br>入口:左侧菜单 → 系统设置 → 数据管理\r<br>\r<br><ul><li>结算并重新开始</li></ul>\r<br> - 会把当前未结算的积分记录归档为一个阶段\r<br> - 会将所有学生当前积分清零\r<br> - 学生名单不变;结算后的历史在“结算历史”查看\r<br><ul><li>导出 JSON(强烈建议定期备份)</li></ul>\r<br> - 导入会覆盖现有学生/理由/积分记录/设置\r<br> - 安全相关设置(密码等)不会随导入写入\r<br>\r<br><h2>开发与运行(面向贡献者)</h2>\r<br>\r<br><h2>MCP 文档</h2>\r<br>\r<br><ul><li>[MCP-使用说明](./MCP-使用说明.md)</li></ul>\r<br>\r<br><h3>环境要求</h3>\r<br>\r<br><ul><li>Node.js(建议使用 LTS 版本)</li></ul>\r<br><ul><li>pnpm</li></ul>\r<br>\r<br><h3>安装依赖</h3>\r<br>\r<br>``<code>bash\r<br>pnpm install\r<br></code>`<code>\r<br>\r<br><h3>开发模式</h3>\r<br>\r<br></code>`<code>bash\r<br>pnpm dev\r<br></code>`<code>\r<br>\r<br><h3>构建</h3>\r<br>\r<br></code>`<code>bash\r<br>pnpm build\r<br></code>`<code>\r<br>\r<br>(可选)打包:\r<br>\r<br></code>`<code>bash\r<br>pnpm build:win\r<br>pnpm build:unpack\r<br></code>`<code>\r<br>\r<br><h3>常用检查</h3>\r<br>\r<br></code>`<code>bash\r<br>pnpm lint\r<br>pnpm typecheck\r<br></code>``\r<br>",
|
||
"rawMarkdown": "# SecScore\r\n\r\n<!-- GitHub 徽章 -->\r\n<p align=\"center\">\r\n <a href=\"https://github.com/SECTL/SecScore/releases\"><img alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/SECTL/SecScore?style=flat-square\"></a>\r\n <a href=\"https://github.com/SECTL/SecScore/releases\"><img alt=\"Downloads\" src=\"https://img.shields.io/github/downloads/SECTL/SecScore/total?style=flat-square\"></a>\r\n <a href=\"https://github.com/SECTL/SecScore/blob/main/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/github/license/SECTL/SecScore?style=flat-square\"></a>\r\n <a href=\"https://github.com/SECTL/SecScore/issues\"><img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/SECTL/SecScore?style=flat-square\"></a>\r\n <a href=\"https://github.com/SECTL/SecScore/pulls\"><img alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/SECTL/SecScore?style=flat-square\"></a>\r\n <img alt=\"Electron\" src=\"https://img.shields.io/badge/Electron-39+-47848F?style=flat-square&logo=electron\">\r\n <img alt=\"React\" src=\"https://img.shields.io/badge/React-19+-61DAFB?style=flat-square&logo=react\">\r\n <img alt=\"TypeScript\" src=\"https://img.shields.io/badge/TypeScript-5+-3178C6?style=flat-square&logo=typescript\">\r\n <img alt=\"Vite\" src=\"https://img.shields.io/badge/Vite-7+-646CFF?style=flat-square&logo=vite\">\r\n</p>\r\n\r\nSecScore 是一款教育积分管理软件,基于 Electron + React + TypeScript 开发,用于管理学生名单、记录加/扣分、查看排行榜与结算历史,并提供权限保护与数据备份。\r\n\r\n## 主要功能\r\n\r\n- 学生管理\r\n - 添加/删除学生\r\n - 通过 xlsx 批量导入名单(支持导入前预览与选择“姓名列”)\r\n- 积分管理\r\n - 选择学生并提交加分/扣分\r\n - 支持“预设理由”一键填充理由与分值\r\n - 支持撤销最近的积分记录(撤销后学生积分会回滚)\r\n- 理由管理\r\n - 维护“预设理由”(分类、理由内容、预设分值)\r\n- 排行榜\r\n - 支持按“今天 / 本周 / 本月”查看积分变化\r\n - 支持导出排行榜为 XLSX\r\n - 支持查看单个学生的操作记录(文本列表)\r\n- 结算与历史\r\n - “结算并重新开始”:把当前未结算记录归档为一个阶段,并将所有学生当前积分清零\r\n - 在“结算历史”查看每个阶段的排行榜\r\n- 系统设置\r\n - 主题切换\r\n - 日志查看/导出/清空\r\n - 数据导入/导出(JSON)\r\n - 密码保护(管理密码 / 积分密码)与找回字符串\r\n\r\n## 使用方法\r\n\r\n### 1. 权限与解锁\r\n\r\n- 右上角会显示当前权限:管理权限 / 积分权限 / 只读\r\n- 若设置了密码,可通过右上角“输入密码”进行解锁\r\n - 管理密码:全功能(学生管理、理由管理、结算、数据管理等)\r\n - 积分密码:仅允许积分相关操作\r\n- 点击“锁定”可切回只读状态\r\n- 无密码时默认视为管理权限\r\n\r\n### 2. 学生管理(导入名单)\r\n\r\n入口:左侧菜单 → 学生管理 → 导入名单\r\n\r\n- 通过 xlsx 导入\r\n 1. 选择一个 `.xlsx` 文件(默认读取第一个工作表)\r\n 2. 在预览表格里点击表头,选择“姓名列”\r\n 3. 点击“导入”\r\n 4. 导入完成后会提示“新增 / 跳过”数量\r\n\r\n建议:姓名列尽量只包含纯姓名文本;同名学生会被视为重复并跳过。\r\n\r\n### 3. 积分管理(加分/扣分)\r\n\r\n入口:左侧菜单 → 积分管理\r\n\r\n1. 在“姓名”选择一个学生(支持搜索)\r\n2. 选择“加分/扣分”,并输入分值\r\n3. 在“理由内容”填写原因(可手动输入)\r\n4. 点击“确认提交”\r\n\r\n快捷理由:\r\n\r\n- 可在“快捷理由”下拉框中选择预设理由,一键填充理由内容/分值(优先尊重你当前是否已手动输入分值)\r\n\r\n撤销最近记录:\r\n\r\n- “最近记录”默认折叠,展开后可对记录点击“撤销”\r\n- 撤销会回滚该条记录对学生积分的影响\r\n\r\n### 4. 排行榜与导出\r\n\r\n入口:左侧菜单 → 排行榜\r\n\r\n- 可切换统计范围:今天 / 本周 / 本月\r\n- 点击“导出 XLSX”可导出当前排行榜\r\n- 点击某个学生的“查看”可打开该学生的操作记录\r\n\r\n### 5. 结算与数据备份\r\n\r\n入口:左侧菜单 → 系统设置 → 数据管理\r\n\r\n- 结算并重新开始\r\n - 会把当前未结算的积分记录归档为一个阶段\r\n - 会将所有学生当前积分清零\r\n - 学生名单不变;结算后的历史在“结算历史”查看\r\n- 导出 JSON(强烈建议定期备份)\r\n - 导入会覆盖现有学生/理由/积分记录/设置\r\n - 安全相关设置(密码等)不会随导入写入\r\n\r\n## 开发与运行(面向贡献者)\r\n\r\n## MCP 文档\r\n\r\n- [MCP-使用说明](./MCP-使用说明.md)\r\n\r\n### 环境要求\r\n\r\n- Node.js(建议使用 LTS 版本)\r\n- pnpm\r\n\r\n### 安装依赖\r\n\r\n```bash\r\npnpm install\r\n```\r\n\r\n### 开发模式\r\n\r\n```bash\r\npnpm dev\r\n```\r\n\r\n### 构建\r\n\r\n```bash\r\npnpm build\r\n```\r\n\r\n(可选)打包:\r\n\r\n```bash\r\npnpm build:win\r\npnpm build:unpack\r\n```\r\n\r\n### 常用检查\r\n\r\n```bash\r\npnpm lint\r\npnpm typecheck\r\n```\r\n"
|
||
} |