|
|
Atomgit
Atomgit
简体中文 | 繁體中文 | English | ไทย | Tiếng Việt | 日本語 | Русский
# Toonflow
AI-фабрика коротких сериалов
Одним движением — роман за секунду становится сериалом!
AI-сценарий × AI-изображения × Молниеносная генерация 🔥
---
# 🚀 Установка
## Предварительные требования
Перед установкой и использованием программы подготовьте следующее:
- ✅ Адрес API сервиса языковой AI-модели
- ✅ Адрес API Sora или Doubao для видео
- ✅ Адрес API сервиса модели Nano Banana Pro для генерации изображений
## Установка локально
### 1. Скачивание и установка
| Операционная система | GitHub | Atomgit | Скачать из Quark Net Disk | Описание |
| :------------------: | :---------------------------------------------------------- | :------------------------------------------------------------- | :-------------------------------------------------- | :------------------ |
| Windows | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет |
| Linux | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет |
| macOS | [Release](https://github.com/HBAI-Ltd/Toonflow-app/releases) | [Release](https://gitcode.com/HBAI-Ltd/Toonflow-app/releases) | [Quark Net Disk](https://pan.quark.cn/s/94ef07509df0) | Официальный установочный пакет |
> [!CAUTION]
> Для macOS: откройте "Настройки → Конфиденциальность и безопасность" и настройте параметры безопасности, иначе может не открыться из-за проблемы с сертификатом.
>
> См. на Zhihu: [https://www.zhihu.com/question/433389276](https://www.zhihu.com/question/433389276)
> Из-за ограничений Gitee OS и лимита по размеру файлов Release — отдельная ссылка для загрузки с Gitee временно недоступна.
### 2. Запуск сервиса
После установки запустите приложение для начала работы.
> ⚠️ **Первый вход**
> Логин: `admin`
> Пароль: `admin123`
## Развертывание через Docker
### Предварительные требования
- Установлен [Docker](https://docs.docker.com/get-docker/) (версия 20.10+)
### Способ 1: Онлайн-развертывание
В разработке — пока используйте локальную сборку.
### Способ 2: Локальная сборка
Собирается локально из скачанного репозитория, подходит для разработчиков либо скачавших код через git:
```shell
# Клонировать проект (если уже есть — пропустите)
git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
# Запускаем сборку и запуск с помощью docker-compose
yarn docker:local
# Или вручную
docker build -t toonflow .
docker run -d -p <локальный_порт>:10588 -v <путь_к_данным>:/app/data toonflow
# Доступ по адресу: http://localhost:10588/web/index.html
```
### Описание портов
| Порт | Назначение | Мэппинг в контейнере |
| -------- | ------------- | ---------------------------- |
| `10588` | Web-интерфейс | `10588:10588` |
**Переменные окружения:**
| Переменная | Описание |
| ------------ | --------------------------------------- |
| `NODE_ENV` | Среда запуска, `prod` — продуктивная |
| `PORT` | Порт службы (по умолчанию 10588) |
| `OSSURL` | Доступ к хранилищу файлов, для статики |
---
## Развёртывание в облаке
### 1. Требования к серверу
- **ОС**: Ubuntu 20.04+ / CentOS 7+
- **Node.js**: 24.x (рекомендуется; минимум 23.11.1+)
- **ОЗУ**: от 2 ГБ
### 2. Развёртывание на сервере
#### 1. Установка окружения
```bash
# Установка Node.js
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 24
# Установка Yarn и PM2
npm install -g yarn pm2
```
#### 2. Развёртывание проекта
**Клонировать из GitHub:**
```bash
cd /opt
git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
yarn install
yarn build
```
**Клонировать из Gitee (для пользователей из Китая):**
```bash
cd /opt
git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
yarn install
yarn build
```
#### 3. Настройка PM2
Создайте файл `pm2.json`:
```json
{
"name": "toonflow-app",
"script": "data/serve/app.js",
"instances": "max",
"exec_mode": "cluster",
"env": {
"NODE_ENV": "prod",
"PORT": 10588,
"OSSURL": "http://127.0.0.1:10588/"
}
}
```
**Описание переменных:**
| Переменная | Описание |
| ------------ | --------------------------------|
| `NODE_ENV` | Среда запуска, `prod` — продакшн |
| `PORT` | Слушаемый порт |
| `OSSURL` | Адрес доступа к статике |
---
#### 4. Запуск сервиса
```bash
pm2 start pm2.json
pm2 startup
pm2 save
```
#### 5. Полезные команды
```bash
pm2 list # Список процессов
pm2 logs toonflow-app # Просмотр логов
pm2 restart all # Перезапуск сервиса
pm2 monit # Мониторинг
```
> ⚠️ **Первый вход**
> Логин: `admin`
> Пароль: `admin123`
#### 6. Развёртывание фронта
Если нужна кастомизация интерфейса или отдельное развертывание фронта — используйте репозиторий фронтенда:
- **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web)
- **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web)
> 💡 **Примечание:** В этот репозиторий уже встроен скомпилированный фронт. Обычным пользователям отдельная установка канала не требуется. Фронт-репозиторий — только для тех, кто хочет разрабатывать/модифицировать UI.
---
# 🔧 Руководство по процессу разработки
> [!CAUTION]
> 🚧 **Правила по PR** 🚧
>
> ⛔ В `master` запрещены любые PR | ✅ Создавайте PR только в ветку `develop`
>
> Разработчиков приглашаем к со-разработке Toonflow! Для участия пишите главному админу ACT в группу.
## 🛠️ Технологический стек
| Категория | Технологии |
| ------------ | ------------------------------------------------------------------------------------------------------------------- |
| Рантайм | Node.js 23.11.1+ |
| Язык | TypeScript 5.x |
| Бэкенд | Express 5 |
| БД | SQLite (better-sqlite3 / knex) |
| AI-интеграции| Vercel AI SDK (OpenAI / Anthropic / Google / DeepSeek / Zhihu / MiniMax / Tongyi Qianwen / xAI) |
| Локальный AI | @huggingface/transformers (ONNX) |
| RTC | Socket.IO |
| Десктоп-клиент| Electron 40 |
| Графика | Sharp |
| Контейнеризация| Docker |
## Подготовка среды разработки
- **Node.js**: не ниже 23.11.1
- **Yarn**: рекомендуется менеджер пакетов
## Быстрый старт проекта
1. **Клонируйте проект**
**С GitHub:**
```bash
git clone https://github.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
```
**С Gitee:**
```bash
git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git
cd Toonflow-app
```
2. **Установите зависимости**
В корне проекта выполните:
```bash
yarn install
```
3. **Запуск среды разработки**
Проект состоит из backend API и frontend. Возможные варианты запуска:
- **1: Только backend**
```bash
yarn dev
```
> ⚠️ Запускает только backend API (порт 10588); без интерфейса. Для доступа к UI — используйте отдельный frontend проект или запускайте через GUI-модули ниже.
- **2: Electron-desktop-клиент**
```bash
yarn dev:gui
```
> Открывает backend и Electron GUI-окно — всё встроено, без доп. настроек. Рекомендуется для полноценного использования.
- **3: Режим продакшн**
```bash
yarn start
```
> Запуск производственной сборки (предварительно `yarn build` обязателен).
4. **Сборка проекта**
- Компиляция .ts файлов:
```bash
yarn build
```
- Сборка exe для Windows:
```bash
yarn dist:win
```
- Сборка для Mac:
```bash
yarn dist:mac
```
- Сборка для Linux:
```bash
yarn dist:linux
```
5. **Lint и проверка кода**
- Проверка кода на ошибки и стиль:
```bash
yarn lint
```
6. **AI Debug-панель (по желанию)**
Запуск GUI для отладки AI SDK:
```bash
yarn debug:ai
```
## Фронтенд разработка
Для редактирования интерфейса используйте фронт-репозиторий:
- **GitHub**: [Toonflow-web](https://github.com/HBAI-Ltd/Toonflow-web)
- **Gitee**: [Toonflow-web](https://gitee.com/HBAI-Ltd/Toonflow-web)
После сборки фронта (`dist/`) скопируйте его содержимое в `data/web/` основного проекта.
## Структура проекта
```
📂 build/ # Скомпилированные файлы
📂 data/ # Данные во время работы
│ ├─ 📂 models/ # Локальные AI-модели (ONNX)
│ ├─ 📂 oss/ # Объектное хранилище (ассеты/персонажи/сцены)
│ ├─ 📂 serve/ # Вход в проде
│ ├─ 📂 skills/ # Prompt-словари умений Agent
│ └─ 📂 web/ # Скомпилированный фронтенд (встроен)
📂 docs/ # Документация
📂 env/ # Переменные окружения
📂 scripts/ # Скрипты и утилиты
📂 src/
├─ 📂 agents/ # AI agent-модули
│ ├─ 📂 productionAgent/ # Агент генерации
│ └─ 📂 scriptAgent/ # Агент сценария
├─ 📂 lib/ # Общие библиотеки
├─ 📂 middleware/ # Мидлвари
├─ 📂 routes/ # Роутинг модули
│ ├─ 📂 agents/ # Память агента
│ ├─ 📂 artStyle/ # Управление стилями
│ ├─ 📂 assets/ # Ассеты
│ ├─ 📂 assetsGenerate/ # Генерация ассетов
│ ├─ 📂 cornerScape/ # Раскадровка
│ ├─ 📂 general/ # Общие эндпоинты
│ ├─ 📂 login/ # Авторизация
│ ├─ 📂 migrate/ # Миграции
│ ├─ 📂 modelSelect/ # Выбор модели
│ ├─ 📂 novel/ # Управление романами
│ ├─ 📂 other/ # Другое
│ ├─ 📂 production/ # Управление производством
│ ├─ 📂 project/ # Управление проектом
│ ├─ 📂 script/ # Генерация сценария
│ ├─ 📂 scriptAgent/ # Эндпоинты агента сценария
│ ├─ 📂 setting/ # Настройки системы
│ ├─ 📂 task/ # Задачи
│ └─ 📂 test/ # Тестовые эндпоинты
├─ 📂 socket/ # RealTime WebSocket
├─ 📂 types/ # TypeScript типы
├─ 📂 utils/ # Утилиты
├─ 📄 app.ts # Точка входа
├─ 📄 core.ts # Инициализация ядра
├─ 📄 env.ts # Работа с окружением
├─ 📄 err.ts # Обработка ошибок
├─ 📄 logger.ts # Модуль логгирования
├─ 📄 router.ts # Регистрация роутов
└─ 📄 utils.ts # Вспомогательные функции
📄 Dockerfile # Dockerfile
📄 electron-builder.yml # Конфиг Electron Builder
📄 skillList.json # Список навыков
📄 LICENSE # Лицензия (Apache-2.0)
📄 NOTICES.txt # Информация о сторонних зависимостях
📄 package.json # Конфиг пакетов
📄 tsconfig.json # Конфиг TypeScript
```
---
# 🔗 Связанные репозитории
| Репозиторий | Описание | GitHub | Gitee |
| ---------------- | ------------------------------------- | -------------------------------------------------- | ------------------------------------------------ |
| **Toonflow-app** | Полный клиент (этот, для обычных пользователей) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-app) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-app) |
| **Toonflow-web** | Исходный код фронта (для фронтэндеров) | [GitHub](https://github.com/HBAI-Ltd/Toonflow-web) | [Gitee](https://gitee.com/HBAI-Ltd/Toonflow-web) |
> 💡 **Подсказка:** если вы просто хотите пользоваться Toonflow — скачайте этот клиент. Отдельный frontend нужен только разработчикам UI.
---
# 👨👩👧👦 WeChat-группы
Ассистент по добавлению в группу:
---
# 💌 Обратная связь
📧 Email: [ltlctools@outlook.com](mailto:ltlctools@outlook.com?subject=Toonflow咨询)
---
# 📜 Лицензия
Toonflow распространяется по лицензии Apache-2.0 с дополнительным коммерческим соглашением.
Подробности: https://www.apache.org/licenses/LICENSE-2.0
## Дополнительное соглашение
- Если вы распространяете данное ПО как продукт **2 и более независимым третьим сторонам**, необходимо получить **письменную коммерческую лицензию** от HBAI-Ltd.
- **≤ 5 юридических лиц**, совместно использующих ПО для внутренних нужд без предоставления услуг третьим сторонам — это **внутреннее использование, лицензия не требуется**.
- Запрещено удалять или изменять товарные знаки, логотипы или уведомления об авторских правах Toonflow.
## Всегда бесплатно — без лицензии
- ✅ Создание контента в Toonflow и получение дохода на платформах
- ✅ Доработка для внутреннего использования команды
- ✅ ≤ 5 юрлиц — совместная внутренняя эксплуатация
- ✅ Личное обучение, исследования, некоммерческое использование
## Цены на коммерческую лицензию
| Этап | Годовой оборот | Годовая плата |
|------|---------|------|
| 🌱 Старт | < ¥100 тыс. | **Бесплатно** |
| 🚀 Стартап | ¥100–500 тыс. | ¥5 000/год |
| 📈 Рост | ¥500 тыс.–1,5 млн | ¥20 000/год |
| 🏢 Масштаб | ¥1,5–5 млн | ¥80 000/год |
| 🌐 Корпоративный | > ¥5 млн | По договорённости |
> **Условие отсутствия обратной силы**: Пользователи, использовавшие Toonflow по AGPL-3.0 до релиза v1.0.8, продолжают работу по AGPL-3.0 и не затрагиваются данным изменением.
Полный текст соглашения см. в файле [LICENSE](../LICENSE).
---
# ⭐️ История звёзд
[](https://www.star-history.com/#HBAI-Ltd/Toonflow-app&type=timeline&legend=top-left)
---
# 🙏 Благодарности
Спасибо нижеперечисленным open-source проектам за мощную поддержку Toonflow:
- [Express](https://expressjs.com/) — быстрый, открытый и лёгкий фреймворк для Node.js
- [AI SDK](https://ai-sdk.dev/) — инструменты AI для TypeScript
- [Better-SQLite3](https://github.com/WiseLibs/better-sqlite3) — высокопроизводительная обвязка SQLite3
- [Sharp](https://sharp.pixelplumbing.com/) — быстрая библиотека для работы с изображениями на Node.js
- [Axios](https://axios-http.com/) — HTTP-клиент на промисах
- [Zod](https://zod.dev/) — TS-first валидация схем
- [Socket.IO](https://socket.io/) — обмен событиями в реальном времени
- [Electron](https://www.electronjs.org/) — кроссплатформенный desktop-фреймворк
- [Hugging Face Transformers](https://huggingface.co/docs/transformers.js) — фреймворк для локального ML
Спасибо за поддержку проекту Toonflow от следующих организаций:
|
Sophnet Cloud — спонсор вычислительных ресурсов [сайт] |