From 5e8d674fb5ed08536c78ac9e7d0388f6170ef967 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?ACT=E4=B8=B6=E6=B5=81=E6=98=9F=E9=9B=A8?= <1340145680@qq.com> Date: Sat, 28 Feb 2026 22:22:06 +0800 Subject: [PATCH] no message --- README.md | 55 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 3279f7e..01b21d7 100644 --- a/README.md +++ b/README.md @@ -100,13 +100,11 @@ https://www.bilibili.com/video/BV1na6wB6Ea2 ### 1. 下载与安装 -| 操作系统 | GitHub 下载 | 123 云盘下载 | 说明 | -| :------: | :----------------------------------------------------------- | :------------------------------------------------ | :------------- | -| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [123 云盘](https://www.123865.com/s/bkn5Vv-E67cv) | 官方发布安装包 | -| Linux | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 | -| macOS | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 | - -> ⚠️ 如 123 云盘提示需付费，仅因云盘流量受限，本软件完全开源免费。 +| 操作系统 | GitHub 下载 | 夸克网盘下载 | 说明 | +| :------: | :----------------------------------------------------------- | :---------------------------------------------- | :------------- | +| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [夸克网盘](https://pan.quark.cn/s/94ef07509df0) | 官方发布安装包 | +| Linux | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 | +| macOS | ⚙️ 敬请期待 | ⚙️ 敬请期待 | 即将发布 | > 目前仅支持 Windows 版本，其他系统将陆续开放。 @@ -137,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 > 默认分支 @@ -173,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` | ### 数据持久化 @@ -185,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 # 持久化数据库（如有） ``` ### 常用操作命令 @@ -317,6 +315,11 @@ pm2 monit # 监控面板 # 🔧 开发流程指南 +> [!CAUTION] +> 🚧 **PR 提交规范** 🚧 +> +> ⛔ `master` 分支不接受任何 PR ｜ ✅ 请将 PR 提交到 `develop` 分支 + ## 开发环境准备 - **Node.js**：版本要求 23.11.1 及以上 @@ -370,10 +373,10 @@ pm2 monit # 监控面板 **两种模式对比：** - | 命令 | 启动内容 | 前端页面 | 适用场景 | - | -------------- | ---------------------- | -------- | -------------------------------- | + | 命令 | 启动内容 | 前端页面 | 适用场景 | + | -------------- | ------------------------ | -------- | -------------------------------- | | `yarn dev` | 仅后端 API（端口 60000） | ❌ 无 | 后端开发调试、配合前端项目联调 | - | `yarn dev:gui` | 后端 + Electron 桌面端 | ✅ 内置 | 完整功能体验、桌面客户端开发调试 | + | `yarn dev:gui` | 后端 + Electron 桌面端 | ✅ 内置 | 完整功能体验、桌面客户端开发调试 | 4. **项目打包** @@ -388,7 +391,7 @@ pm2 monit # 监控面板 ```bash yarn dist:win ``` - + - 打包为 Mac 平台可执行程序： ```bash @@ -523,9 +526,13 @@ pm2 monit # 监控面板 ~~交流群 10~~ -交流群 11: +~~交流群 11~~ -Toonflow Logo +~~交流群 12~~ + +交流群 13: + +Toonflow Logo

使用微信扫码添加，二维码过期可提交 Issues 提醒更新

---