REPOSITORY MAP / v2.4.4
仓库文件地图
用一张可扫描的地图找到产品入口、服务端、客户端、移动端、测试、文档和发布脚本。新手从“从哪里开始”开始，贡献者再进入构建与测试。
返回在线展示下载 Markdown 原文README打开入口route / menu
填写配置input / policy
保存状态server / data
验证结果client / check
拖动 360° · 滚轮缩放 · 方向键微调
从哪里开始
- 先看根目录 README，再打开 GitHub Pages 在线展示。
- 实际使用时下载 Releases 中的 Windows、Android 或独立服务器文件；不要把 Source code zip 当安装包。
- 修改功能前阅读 docs/architecture.md、CONTRIBUTING.md 和 PRODUCT.md。
- 重新构建时按平台调用 build-windows.ps1、build-server-package.ps1 或 mobile/build-apk.ps1。
目录职责
| 路径 | 职责 | 新手动作 |
|---|---|---|
| public/ | 浏览器界面、播放器、管理中心和前端资源 | 修改界面后运行前端契约测试 |
| server/ | Express API、Socket.IO、认证、房间、媒体和 Tunnel | 后端变更补充接口或集成测试 |
| mobile/ | Android Java/JNI、Gradle 和 APK 构建 | 使用 build-apk.ps1 验证签名与 ABI |
| tests/ | 功能、隐私、桌面、Android、Tunnel 和发布验收 | 提交前运行专项测试 |
| docs/ | Pages 展示、截图、教程、架构和模块页面 | 文档修改后检查链接和手机布局 |
| scripts/ | Cloudflare、发布和文档生成辅助脚本 | 只按文档调用，不提交临时产物 |
发布与保护
.github/workflows/ci.yml 在 PR 和 main 上运行检查；pages.yml 只发布 docs/ 静态站；发布 workflow 负责生成成品。release/、node_modules/、数据目录、签名材料和密钥均不提交源码仓库。外部贡献通过 Fork → 分支 → Pull Request → 自动检查 → 维护者审核进入 main。