zyc/video-flow-toon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
HBAI-Ltd 2026-02-27 18:48:28 +08:00 committed by GitHub
parent 6189ab3f42
commit 8753d88b1a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -100,11 +100,11 @@ https://www.bilibili.com/video/BV1na6wB6Ea2
### 1. 下载与安装
| 操作系统 | GitHub 下载 | 夸克网盘下载 | 说明 |
| :------: | :----------------------------------------------------------- | :------------------------------------------------ | :------------- |
| 操作系统 | GitHub 下载 | 夸克网盘下载 | 说明 |
| :------: | :----------------------------------------------------------- | :---------------------------------------------- | :------------- |
| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [夸克网盘](https://pan.quark.cn/s/94ef07509df0) | 官方发布安装包 |
| Linux | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 |
| macOS | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 |
| Linux | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 |
| macOS | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 |
> 目前仅支持 Windows 版本，其他系统将陆续开放。
@ -135,11 +135,11 @@ docker-compose -f docker/docker-compose.yml up -d --build
**支持的构建参数：**
| 参数 | 说明 | 默认值 | 示例 |
| ---------- | ----------------------- | ---------- | --------------------------- |
| `GIT` | 代码仓库源 | `github` | `github` / `gitee` |
| `TAG` | 指定版本标签 | 最新 tag | `v1.0.6` |
| `BRANCH` | 指定分支 | 默认分支 | `main` / `dev` |
| 参数 | 说明 | 默认值 | 示例 |
| -------- | ------------ | -------- | ------------------ |
| `GIT` | 代码仓库源 | `github` | `github` / `gitee` |
| `TAG` | 指定版本标签 | 最新 tag | `v1.0.6` |
| `BRANCH` | 指定分支 | 默认分支 | `main` / `dev` |
**版本选择优先级**：指定 TAG > 指定 BRANCH > 自动获取最新 tag > 默认分支
@ -171,10 +171,10 @@ docker-compose -f docker/docker-compose.local.yml up -d --build
### 服务端口说明
| 端口 | 用途 | 在线部署映射 | 本地构建映射 |
| ------- | ----------------------- | --------------- | ----------------- |
| `80` | Nginx 前端页面 | 随机端口 | `8080:80` |
| `60000` | 后端 API 服务 | `60000:60000` | `60000:60000` |
| 端口 | 用途 | 在线部署映射 | 本地构建映射 |
| ------- | -------------- | ------------- | ------------- |
| `80` | Nginx 前端页面 | 随机端口 | `8080:80` |
| `60000` | 后端 API 服务 | `60000:60000` | `60000:60000` |
### 数据持久化
@ -183,8 +183,8 @@ docker-compose -f docker/docker-compose.local.yml up -d --build
```yaml
volumes:
- ./logs:/var/log
- ./uploads:/app/uploads # 持久化上传文件
- ./data:/app/data # 持久化数据库（如有）
- ./uploads:/app/uploads # 持久化上传文件
- ./data:/app/data # 持久化数据库（如有）
```
### 常用操作命令
@ -315,6 +315,15 @@ pm2 monit # 监控面板
# 🔧 开发流程指南
<div align="center">
<div style="background:repeating-linear-gradient(45deg,#000,#000 10px,#ffcc00 10px,#ffcc00 20px);padding:3px;border:2px solid #000;">
<div style="padding:12px;">
<b style="text-shadow:-1px -1px 0 #000,1px -1px 0 #000,-1px 1px 0 #000,1px 1px 0 #000;">🚧 PR 提交规范 🚧</b><br/>
<span style="text-shadow:-1px -1px 0 #000,1px -1px 0 #000,-1px 1px 0 #000,1px 1px 0 #000;"><b>⛔ </b></span><code>master</code><span style="text-shadow:-1px -1px 0 #000,1px -1px 0 #000,-1px 1px 0 #000,1px 1px 0 #000;"><b> 分支不接受任何 PR &nbsp;│&nbsp; ✅ 请将 PR 提交到 </b></span><code>develop</code><span style="text-shadow:-1px -1px 0 #000,1px -1px 0 #000,-1px 1px 0 #000,1px 1px 0 #000;"><b> 分支</b></span>
</div>
</div>
</div>
## 开发环境准备
- **Node.js**：版本要求 23.11.1 及以上
@ -368,10 +377,10 @@ pm2 monit # 监控面板
**两种模式对比：**
| 命令 | 启动内容 | 前端页面 | 适用场景 |
| -------------- | ---------------------- | -------- | -------------------------------- |
| 命令 | 启动内容 | 前端页面 | 适用场景 |
| -------------- | ------------------------ | -------- | -------------------------------- |
| `yarn dev` | 仅后端 API（端口 60000） | ❌ 无 | 后端开发调试、配合前端项目联调 |
| `yarn dev:gui` | 后端 + Electron 桌面端 | ✅ 内置 | 完整功能体验、桌面客户端开发调试 |
| `yarn dev:gui` | 后端 + Electron 桌面端 | ✅ 内置 | 完整功能体验、桌面客户端开发调试 |
4. **项目打包**
@ -386,7 +395,7 @@ pm2 monit # 监控面板
```bash
yarn dist:win
```
- 打包为 Mac 平台可执行程序：
```bash