# toonflow **Repository Path**: open_free/toonflow ## Basic Information - **Project Name**: toonflow - **Description**: 免费开源项目，主要包含【AI写剧本】【小说转剧本】功能，支持本地部署docker护着安装包，也支持通过官网直接免费试用 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 5 - **Forks**: 3 - **Created**: 2026-03-29 - **Last Updated**: 2026-05-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README  |   |  **中文** | [English](./docs/README.en.md) # 知剧AI **AI 短剧创作平台 ** **小说秒转剧本，剧本延展分镜 ** **前后端与桌面端一体化交付 🔥** 🚀 **一站式短剧工程**：AI 剧本生成 × 小说转剧本 × 分镜辅助 × 管理后台 × 桌面端封装，全流程覆盖！ --- # 🌟 主要功能 知剧AI 是一个面向短剧创作与管理的源码开放项目，提供完整的前端站点、后端 API、管理后台和 Electron 桌面端封装，适合个人学习、研究、非商业本地部署和功能体验。 - ✅ **AI 剧本生成** 支持从创意到结构化剧本的生成与编辑，帮助快速搭建短剧内容骨架。 - ✅ **小说转剧本** 支持小说项目、章节、剧情线到剧本的转换流程，适合影视改编类创作场景。 - ✅ **分镜辅助** 围绕剧本场景生成分镜、封面和画面素材，提升后续视频制作效率。 - ✅ **桌面端封装** 支持 Electron 联调与安装包构建，可输出 Windows / macOS 桌面客户端。 --- # 📦 应用场景 - AI 短剧创作平台 - 小说影视化改编工具 - 私有化内容生产系统 - 桌面端短剧创作工作台 - 面向运营团队的后台管理系统 - 学习和研究型项目参考 --- # 🔰 使用指南 ## 📺 视频教程 **知剧AI 快速上手教程** 👉 [点击观看（待补充）](#) --- # 🚀 安装 ## 前置条件 在安装和使用本软件之前，请准备以下内容： - ✅ Node.js `>= 18` - ✅ npm `>= 9` ## 本机安装 ### 1. 下载与安装 | 操作系统 | GitHub 下载 | 网盘下载 | 说明 | | ------- | --------------------------------------------------------- | -------------- | ------- | | Windows | [Release](https://github.com/openfrees/toonflow/releases) | [网盘下载（待补充）](#) | 官方发布安装包 | | macOS | [Release](https://github.com/openfrees/toonflow/releases) | [网盘下载（待补充）](#) | 官方发布安装包 | | Linux | [Release](https://github.com/openfrees/toonflow/releases) | [网盘下载（待补充）](#) | 待提供 | > 当前仓库已支持 Windows 和 macOS 打包。Release 页地址、网盘地址请后续补上。 ### 2. 启动服务 安装完成后，启动程序即可开始使用本服务。 > ⚠️ **首次登录** > 账号：`手机号`　｜　密码：`随便设置` > 没有任何验证本地登录，所以手机密码随便设置 ## Docker 部署 ### 前置条件 - 已安装 [Docker](https://docs.docker.com/get-docker/)（版本 20.10+） - 已安装 [Docker Compose](https://docs.docker.com/compose/install/)（版本 2.0+） ### 本地 Docker 一键运行 本仓库已经内置根目录 `Dockerfile` 和 `docker-compose.yml`，可直接在本机通过 Docker 跑起前后端。 当前 Docker 方案特点： - 采用 `localhost` 模式启动后端，使用 SQLite 持久化数据 - 前端在镜像构建阶段静态生成，并拷贝到 `storyweaver-api/web` - 前台页面、后端 API、管理后台统一走同一个地址 ### 运行前说明 `docker-compose.yml` 位于项目根目录，所以命令必须在**仓库根目录**执行： ```shell cd /你的项目根目录 ``` ### 启动命令 ```shell # 1. 构建镜像并后台启动容器 # 首次启动或代码更新后，优先用这个命令 docker compose up -d --build # 2. 查看容器运行状态 docker compose ps # 3. 持续查看应用日志 # 适合排查启动失败、接口报错、数据库初始化等问题 docker compose logs -f storyweaver-app # 4. 停止并移除容器 docker compose down ``` ### 访问地址 启动成功后可直接访问： - 前台首页：`http://127.0.0.1:7006/` - 后端健康检查：`http://127.0.0.1:7006/api/health` - 管理后台：`http://127.0.0.1:7006/admin` ### 数据持久化 Docker 运行产生的数据默认保存在宿主机以下目录： ```shell ./docker-data/storyweaver-api/data ./docker-data/storyweaver-api/logs ./docker-data/storyweaver-api/run ``` 其中： - `data`：SQLite 数据库文件 - `logs`：后端运行日志 - `run`：运行时文件 ### 服务端口说明 | 端口 | 用途 | 说明 | | ------ | --------- | ------------- | | `7006` | 后端 API 服务 | Egg.js 默认开发端口 | | `7005` | 前端开发服务 | Nuxt 3 默认开发端口 | ### 数据持久化 当前 Compose 已默认挂载以下目录： ```yaml volumes: - ./docker-data/storyweaver-api/data:/app/storyweaver-api/data - ./docker-data/storyweaver-api/logs:/app/storyweaver-api/logs - ./docker-data/storyweaver-api/run:/app/storyweaver-api/run ``` ### 常用操作命令 ```shell # 重新构建并启动（更新版本时使用） docker compose up -d --build # 仅启动已有镜像（代码未变时使用） docker compose up -d # 查看容器状态 docker compose ps # 查看实时日志 docker compose logs -f storyweaver-app # 停止服务 docker compose down # 进入容器调试 docker exec -it storyweaver-app sh ``` > ⚠️ 首次登录信息见 [本机安装 - 启动服务](#2-启动服务) --- # 🔧 开发流程指南 > [!CAUTION] > 🚧 **PR 提交规范** 🚧 > > > > 请将 PR 提交到指定开发分支（待补充具体分支名） ## 开发环境准备 - **Node.js**：版本要求 18 及以上 - **npm**：推荐最新版 ## 快速启动项目 1. **克隆项目** **从 GitHub 克隆：** **从 Gitee 克隆（国内推荐）：** 2. **安装依赖** 请先在项目根目录下执行以下命令以安装依赖项： 3. **启动开发环境** 本项目包含 **后端 API 服务** 和 **前端页面** 两部分，请根据需要选择启动方式： - **方式一：仅启动后端服务（开发调试用）** ```bash cd storyweaver-api npm run dev ``` > ⚠️ 此命令仅启动后端 API 服务，**不包含前端页面**。如需同时使用前端页面，请配合前端项目单独启动，或使用 Electron 桌面模式。 - **方式二：启动前端页面** ```bash cd storyweaver-web npm run dev ``` - **方式三：启动 Electron 桌面客户端（推荐完整体验）** ```bash cd electron npm run dev ``` > 此命令会启动 Electron 桌面窗口，配合后端服务使用，开箱即用。适合想要完整体验所有功能的开发者。 **三种模式对比：** | 命令 | 启动内容 | 前端页面 | 适用场景 | | ----------------------- | ------------ | ---- | ---------------- | | `npm run dev`（api） | 仅后端 API | ❌ 无 | 后端开发调试、配合前端项目联调 | | `npm run dev`（web） | 仅前端页面 | ✅ 有 | 前端开发调试 | | `npm run dev`（electron） | Electron 桌面端 | ✅ 内置 | 完整功能体验、桌面客户端开发调试 | 4. **项目打包** - 前端本地静态生成： - 前端生产环境构建： ```bash npm run build:prod ``` - 打包为 Windows 平台可执行程序： ```bash cd electron npm run build:win ``` - 打包为 Mac 平台可执行程序： ```bash cd electron npm run build:mac ``` - 全部平台打包： ```bash cd electron npm run build:all ``` 5. **代码质量检查** ```bash cd storyweaver-api npm run test ``` ## 前端开发 前端代码位于 `storyweaver-web`，基于 Nuxt 3 + Vue 3 + Pinia + TypeScript 构建。 常用命令： | 命令 | 说明 | | ------------------------ | ------------------------- | | `npm run dev` | 本地开发（加载 `.env.localhost`） | | `npm run generate:local` | 本地模式静态生成 | | `npm run generate:prod` | 生产环境静态生成 | | `npm run build:prod` | 生产环境 SSR 构建 | ## 项目结构 ``` 📂 storyweaver-web/ # Nuxt 3 前端 📂 storyweaver-api/ # Egg.js 后端与管理后台 │ ├─ 📂 app/ │ │ ├─ 📂 controller/ # 控制器 │ │ ├─ 📂 service/ # 业务逻辑 │ │ ├─ 📂 model/ # 数据模型 │ │ ├─ 📂 middleware/ # 中间件 │ │ ├─ 📂 view/ # Nunjucks 模板（管理后台） │ │ └─ 📂 public/ # 静态资源 │ ├─ 📂 config/ # 配置文件 │ └─ 📂 database/ # 数据库迁移 📂 electron/ # Electron 桌面端封装 │ ├─ 📄 main.js # Electron 入口 │ ├─ 📂 scripts/ # 构建脚本 │ └─ 📂 icons/ # 应用图标 📄 brand-mark-main.svg # 品牌图标源文件 📄 LICENSE # 许可协议 📄 README.md # 项目说明 ``` --- # 🔗 相关仓库 | 仓库 | 说明 | GitHub | Gitee | | ------------------- | --------------- | --------------------------------------------------- | ------------------------------------------------- | | **知剧AI** | 完整项目（本仓库，推荐） | [GitHub](https://github.com/openfrees/toonflow.git) | [Gitee](https://gitee.com/open_free/toonflow.git) | | **storyweaver-web** | 前端源代码（当前仓库子目录） | 同上 | 同上 | | **storyweaver-api** | 后端源代码（当前仓库子目录） | 同上 | 同上 | | **electron** | 桌面端源代码（当前仓库子目录） | 同上 | 同上 | > 💡 **提示**：如果您只是想使用知剧AI，直接下载本仓库的客户端即可。如需二次开发或定制，请克隆完整仓库。 --- # 📝 开发计划 我们正持续优化产品，以下为近期开发重点： 1. 核心功能升级 - `🧩 AI 剧本生成增强` 支持更多 AI 模型接入，优化剧本结构与对白质量 - `📄 小说转剧本优化` 支持多格式文本导入，强化章节解析与剧情线梳理 1. 生产流程优化 - `👗 分镜管理增强` 强化分镜与剧本场景的关联，支持批量生成与调整 - `📦 批量处理/任务队列` 支持多章节同时处理，后台任务管理，进度实时监控 1. 部署与体验增强 - `🐳 Docker 部署模板` 提供开箱即用的 docker-compose.yml - `📱 多端适配` 优化移动端体验，完善桌面端功能 --- # 👨‍👩‍👧‍👦 微信交流群 拉群小助手: > 微信群二维码待补充，有了之后把上面注释取消即可。 --- # 💌 联系我们 📧 邮箱：[toms6688@foxmail.com](mailto:toms6688@foxmail.com?subject=知剧AI咨询) --- # 📜 许可证 知剧AI 采用**个人学习与非商业研究许可协议**发布，许可证详情见 `[LICENSE](./LICENSE)`。 你可以在遵守许可协议全部条款的前提下： - 获取、阅读、下载和保存本项目源码 - 为个人学习、技术研究、功能验证和非商业本地部署目的使用 - 在非商业前提下修改源码，并保留原始版权和许可声明 明确禁止： - 将本项目或其衍生版本用于任何商业目的 - 将本项目用于收费服务、SaaS、云托管、代部署、代运营或技术外包交付 - 销售、转售、出租、授权、分发源码、安装包、镜像或二次开发版本 如需获得商业授权许可，请通过邮箱与我们联系。 --- # 🙏 致谢 感谢以下开源项目为知剧AI提供强大支持： - [Nuxt](https://nuxt.com/) - 基于 Vue 的全栈框架 - [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架 - [Egg.js](https://www.eggjs.org/) - 企业级 Node.js 框架 - [Sequelize](https://sequelize.org/) - Node.js ORM 框架 - [Electron](https://www.electronjs.org/) - 跨平台桌面应用开发框架 - [Pinia](https://pinia.vuejs.org/) - Vue 状态管理库 - [SQLite](https://www.sqlite.org/) - 轻量级嵌入式数据库 - [Sharp](https://sharp.pixelplumbing.com/) - 高性能 Node.js 图像处理库 - [AI SDK](https://ai-sdk.dev/) - 面向 TypeScript 的 AI 工具包 - [Zod](https://zod.dev/) - TypeScript 优先的模式验证库 ##### copyright © 知剧AI