chore: 仓库只保留用户侧文档,移除内部开发文档

This commit is contained in:
AskaEth committed 2026-09-09 18:23:10 +08:00
1 parent 3b3496559b
commit a61d793d79
16 files changed
+72 -1645

No files matched your search

+26 -26
View File
@@ -1,40 +1,40 @@
# Scoreboard · 运动会积分榜系统
# Scoreboard · 赛事积分榜系统
一套局域网内部署的运动会成绩与积分系统:**一个服务端 + 两个界面**。
一套局域网内部署的赛事成绩与积分系统:**一个服务端 + 两个界面**,后台一改数据,前台大屏实时跟着变。
| 界面 | 地址 | 用途 |
| --- | --- | --- |
| 实时积分大屏 | `/display` | 只读、无人值守;成绩发布后 1 秒内更新 |
| 裁判长管理面板 | `/admin` | 登录后录入、审核、发布成绩,控制大屏 |
| 管理面板 | `/admin` | 录入、发布成绩,控制大屏;未登录可只读查看全部赛事数据 |
后台一改数据,前台大屏实时跟着变;草稿不上屏,发布才生效,误操作可撤销、可追溯。
## 功能概览
## 当前状态
- **四个榜**:总积分榜、团体奖牌榜、个人积分奖牌榜、分项成绩表
- **录入即上屏**:成绩录入 → 发布 → 大屏即时更新
- **可追溯、可撤销**:草稿不上屏;发布后纠错走「撤销发布 → 改 → 重新发布」,全程留痕
- **变更历史**:仿 Git 图谱,一眼看清成绩是怎么变成现在这样的
- **现场公开**:积分明细可下钻,争议时一键推送到大屏
- **规则可配置**:积分规则以规则包(YAML)描述,可导入导出、跨赛事复用
- **赛事独立存档**:每个赛事一个独立项目目录,可整包导出/导入
- **结果导出**:Excel 总表与分项可单独导出
📋 **设计阶段** —— 开发文档已成型,等待 D1–D13 决策确认,尚未开始编码。
## 快速开始
1. 解压部署包
2. 双击 `scoreboard.exe`(Linux 下执行 `./scoreboard`)
3. 浏览器打开终端提示的地址
```
大屏 http://<主机IP>:8080/display
管理面板 http://<主机IP>:8080/admin
```
> 完全离线运行,不依赖外网,不需要安装任何运行时。
## 文档
开发文档集见 [`devdocs/`](./devdocs/README.md):
| 编号 | 文档 |
| --- | --- |
| 01 | [需求与范围](./devdocs/01-需求与范围.md) |
| 02 | [积分与排名规则](./devdocs/02-积分与排名规则.md) ★ 核心 |
| 03 | [技术选型与架构](./devdocs/03-技术选型与架构.md) |
| 04 | [数据模型](./devdocs/04-数据模型.md) |
| 05 | [接口与实时协议](./devdocs/05-接口与实时协议.md) |
| 06 | [大屏端设计](./devdocs/06-大屏端设计.md) |
| 07 | [管理面板设计](./devdocs/07-管理面板设计.md) |
| 08 | [安全与可靠性](./devdocs/08-安全与可靠性.md) |
| 09 | [测试策略](./devdocs/09-测试策略.md) |
| 10 | [部署与现场方案](./devdocs/10-部署与现场方案.md) |
| 11 | [开发计划与里程碑](./devdocs/11-开发计划与里程碑.md) |
| 12 | [风险登记册](./devdocs/12-风险登记册.md) |
## 拟定技术栈
Node.js 22 + TypeScript + Fastify + Socket.IO + SQLite + Vue 3 + Vite
- 使用说明、操作手册:随正式版发布补充
- 规则包格式:见 [rules/README.md](./rules/README.md)
## 许可证