审阅坞 ReviewDock

审阅坞是一款本地优先的局域网提审、审核与正式交付工具。创作者在电脑上运行桌面端，审核者直接使用手机或电脑浏览器，正式接收方使用桌面端收取已批准文件。文件与审核数据默认留在你的设备和局域网内，不依赖云盘或第三方账号。

下载最新版本 · 查看测试报告 · 查看发布校验值

当前公开安装包面向 Windows，尚未使用商业代码签名证书。首次运行时 Windows 可能显示来源确认提示，请先核对 Release 页面中的 SHA-256。

它解决什么问题

• 局域网提审：创作者从工作区选择文件或文件夹，并生成独立的 V01、V02…版本快照。
• 手机直接审核：审核者扫码即可预览图片、视频、音频、PDF 和常见文本，无需安装 App。
• 时间码反馈：视频和音频评论可记录当前播放时间，方便精确定位修改点。
• 逐文件审批：每个文件可单独通过或要求修改；只有全部通过的版本才能正式交付。
• 可验证交付：版本快照和交付包记录 SHA-256，接收端下载后再次校验并生成交付清单。
• 本地优先：不要求注册账号，不调用云存储或付费 API。

flowchart LR
    A["创作者桌面端<br/>创建版本快照"] -->|"局域网连接 / 二维码"| B["审核者浏览器<br/>预览、评论、审批"]
    B -->|"反馈与审批结果"| A
    A -->|"仅交付已批准版本"| C["接收者桌面端<br/>校验并保存文件"]

Loading

下载与安装

1. 打开 Releases。
2. Windows 用户选择以下任一文件：
   • ReviewDock-Setup-0.1.0.exe：安装版，可选择安装位置并创建桌面快捷方式。
   • ReviewDock-Portable-0.1.0.exe：便携版，不安装，双击即可运行。
3. 如系统显示安全提示，请先在 Release 页面核对文件大小和 SHA-256，再确认运行。
4. 首次启动时，如果防火墙询问是否允许局域网连接，请仅在可信的专用网络中允许。

安装包和便携版只发布在 GitHub Releases，不存入 Git 源码历史。

使用方法

1. 创作者创建并提交版本

1. 启动“审阅坞”，首次使用选择“创作与提审”，然后选择工作区。
2. 填写日期、品牌和项目名称。创建前会显示目标文件夹；同名项目不会被覆盖。
3. 选择要审核的文件或文件夹。提交前可检查文件名、类型、大小和修改时间。
4. 打开“设备连接”并选择“连接审核设备”，把二维码或完整地址发给审核者。连接码有效期为 15 分钟。
5. 选择已连接的审核设备并提交。每次提交都会生成不可变的 V01、V02…快照，后续修改工作文件不会改变历史版本。
6. 在“反馈与版本”查看逐文件审核状态、评论以及视频/音频时间码。
7. 如需修改，继续处理工作文件并创建新版本；旧版本及其反馈会保留。

2. 审核者在手机或电脑上审核

1. 确保审核设备与创作者电脑连接到同一个可信局域网。
2. 用浏览器扫描二维码或打开创作者提供的完整连接地址。
3. 输入设备名称并确认连接。
4. 打开待审核版本，预览文件、填写评论，并对每个文件选择“通过”或“需要修改”。
5. 播放视频或音频时，可把当前时间写入评论。

图片、视频、音频、PDF 和常见文本可直接预览；其他格式会显示文件信息，并在授权后提供下载。

3. 接收者收取正式文件

1. 在接收电脑安装并启动“审阅坞”，首次使用选择“接收正式文件”。
2. 创作者在“设备连接”中选择“连接接收电脑”，将生成的完整地址发送给接收者。
3. 接收端粘贴地址，输入设备名称并确认连接。
4. 创作者只能选择已全部通过的版本进行正式交付。
5. 交付到达后，接收者点击“选择位置并接收”。程序会校验下载包、展开文件，并显示实际保存位置。

数据与隐私

• 项目文件、版本、评论、审批和交付记录默认保存在所选工作区的 .reviewdock/ 中。
• 服务默认监听 0.0.0.0:41733，因此同一局域网内的设备可以连接；请勿在不可信公共网络中使用。
• 审核内容接口需要设备令牌，创作者管理接口只允许本机桌面窗口访问。
• 设备令牌保存在本机状态中；取消授权后，该设备不能继续访问任务或文件。
• 审阅坞本身不会把项目文件上传到第三方服务，也不需要第三方账号。
• 连接地址包含临时授权信息，请像对待临时密码一样保管，不要发布到公开聊天或网页。

发现安全问题时，请先阅读 SECURITY.md，避免在公开 Issue 中披露令牌、文件或网络信息。

从源码运行

环境要求：Node.js 20+，npm。

git clone https://github.com/stephenandklay/reviewdock.git
cd reviewdock
npm install
npm start

仅启动局域网服务，方便浏览器开发与测试：

$env:REVIEWDOCK_CONFIG_DIR = "$pwd\.reviewdock-dev"
$env:PORT = "41733"
npm run dev:server

构建安装包

Windows：

npm install
npm run dist:win

构建产物位于 dist/，包括安装版、便携版和解包目录。

macOS：

npm install
npm run dist:mac

macOS 产物必须在 macOS 主机或 macOS CI 中构建。仓库内的 build-macos.yml 可以手动生成未签名的 DMG/ZIP；当前版本尚未完成 macOS 实机验收。

测试

npm test
npm run test:e2e
npm run test:desktop
npm run test:packaged

• npm test：后端业务、授权、版本快照、审批、交付和持久化。
• npm run test:e2e：浏览器端完整流程和移动宽度审核界面。
• npm run test:desktop：真实 Electron 创作者端、接收端和原生落盘。
• npm run test:packaged：Windows 打包产物启动验证。

详细覆盖范围和当前尚未完成的物理设备验证见 TEST_REPORT.md。

参与贡献

欢迎提交 Issue 和 Pull Request。开始前请阅读 CONTRIBUTING.md。提交问题时请使用示例文件，并删除截图、日志和路径中的个人信息。

许可证

本项目基于 MIT License 开源。