2023-05-07 19:11:16 +00:00
|
|
|
|
# Getting started
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
pnpm i
|
2023-05-07 20:31:46 +00:00
|
|
|
|
pnpm start
|
2023-05-07 19:11:16 +00:00
|
|
|
|
```
|
2023-05-07 22:29:37 +00:00
|
|
|
|
|
2023-05-08 16:39:20 +00:00
|
|
|
|
## 架构
|
|
|
|
|
|
|
|
|
|
- 浏览器主线程: 渲染界面,处理 UI 更新
|
|
|
|
|
- Web Worker: 负责计算方面的内容,如内容解密。
|
|
|
|
|
|
|
|
|
|
数据传输: 生成 blob url (`URL.createObjectURL`) 然后透过 `postMessage` 传递给线程,线程利用 `fetch` API 来获取文件信息。
|
2023-05-08 16:57:34 +00:00
|
|
|
|
|
2023-05-08 17:02:14 +00:00
|
|
|
|
## 贡献代码
|
|
|
|
|
|
|
|
|
|
欢迎贡献代码。请确保:
|
|
|
|
|
|
|
|
|
|
- 单元测试的覆盖率不低于主分支的覆盖率;
|
|
|
|
|
- 提交前请使用 Prettier 对代码进行格式化;
|
|
|
|
|
- 提交前请确保 ESLint 不会报告 warning / error;
|
|
|
|
|
|
|
|
|
|
满足上述条件后发起 Pull Request,仓库管理员审阅后将合并到主分支。
|
|
|
|
|
|
2023-05-08 16:57:34 +00:00
|
|
|
|
## TODO
|
|
|
|
|
|
2023-05-08 17:02:04 +00:00
|
|
|
|
- [ ] #6 文件拖放 (利用 `react-dropzone`?)
|
2023-05-08 16:57:34 +00:00
|
|
|
|
- [ ] 各类算法 [追踪 `crypto` 标签](https://git.unlock-music.dev/um/um-react/issues?labels=67)
|
2023-05-08 17:02:04 +00:00
|
|
|
|
- [ ] #7 简易元数据编辑器
|
|
|
|
|
- [ ] #8 添加单元测试
|