### Local Docker Build and Run Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Build the project locally using Docker and start the service. Ensure Docker and git are installed. Access the UI at the specified port. ```shell # Clone the project first (skip if already cloned) git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app # Build and start locally using docker-compose yarn docker:local # Or build manually docker build -t toonflow . docker run -d -p :10588 -v :/app/data toonflow # Access the page at the corresponding port path /web/index.html # Example: http://localhost:10588/web/index.html ``` -------------------------------- ### Install Node.js, Yarn, and PM2 Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.zhtw.md Installs Node.js using nvm, then installs Yarn and PM2 globally. Ensure Node.js version 24.x is used. ```bash 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 ``` -------------------------------- ### Install Node.js, Yarn, and PM2 for Cloud Deployment Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Installs Node.js version 24.x using nvm, then installs Yarn and PM2 globally. This is a prerequisite for cloud deployment. ```shell # Install Node.js curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash source ~/.bashrc nvm install 24 # Install Yarn and PM2 npm install -g yarn pm2 ``` -------------------------------- ### Start Electron Desktop Client (Full Experience) Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md This command starts both the backend service and the Electron desktop window with a built-in frontend, providing a complete out-of-the-box experience for developers. ```bash yarn dev:gui ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Run this command in the project root to install all necessary dependencies for the Toonflow App. ```bash yarn install ``` -------------------------------- ### Start Production Mode Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Runs the compiled service in production mode. Ensure you have run `yarn build` first. ```bash yarn start ``` -------------------------------- ### Start and Manage Service with PM2 Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.zhtw.md Starts the Toonflow application using PM2 with the defined configuration, sets up PM2 startup scripts, and saves the current process list. ```bash pm2 start pm2.json pm2 startup pm2 save ``` -------------------------------- ### Start Backend API Service Only Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md This command starts only the backend API service on port 10588. It does not include the frontend. Accessing the local address will only call API endpoints. ```bash yarn dev ``` -------------------------------- ### Deploy Toonflow-app from Gitee Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Clones the Toonflow-app repository from Gitee, installs dependencies, and builds the project. Recommended for users in China. ```shell cd /opt git clone https://gitee.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app yarn install yarn build ``` -------------------------------- ### Deploy Toonflow-app from GitHub Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Clones the Toonflow-app repository from GitHub, installs dependencies, and builds the project. This is part of the cloud deployment process. ```shell cd /opt git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app yarn install yarn build ``` -------------------------------- ### Ancient Chinese Accessory Prompt Elements Source: https://github.com/hbai-ltd/toonflow-app/blob/master/data/skills/art_skills/realpeople_ancient_chinese/art_prompt/art_prop.md Example prompt elements for generating ancient Chinese accessories, detailing type, materials, craftsmanship, and luster. ```text 簪/钗/璎珞/玉佩/手镯/耳坠 金/银/玉/珍珠/宝石 极致精细、花丝/掐丝/镶嵌 珠光/玉润/金属光泽 古风{饰品}，{材质}，大师工艺，精雕细琢 ``` -------------------------------- ### Local Docker Deployment Command Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.zhtw.md Use this command to build and start Toonflow locally using Docker Compose. Ensure you have cloned the repository first. ```shell # 先克隆專案（如已有則跳過） git clone https://github.com/HBAI-Ltd/Toonflow-app.git cd Toonflow-app # 使用 docker-compose 本地建置並啟動 yarn docker:local ``` -------------------------------- ### Ancient Chinese Weapon Prompt Elements Source: https://github.com/hbai-ltd/toonflow-app/blob/master/data/skills/art_skills/realpeople_ancient_chinese/art_prompt/art_prop.md Example prompt elements for generating ancient Chinese weapons, specifying type, material, decoration, and visual effects like luster. ```text 剑/刀/弓/枪/扇 精钢/玄铁 + 宝石镶嵌 + 丝绸剑穗 剑鞘/刀柄雕花、流苏、暗纹 金属冷光泽、刃口反光 古风{兵器}，精钢锻造，寒光凛冽，雕花精致 ``` -------------------------------- ### Storyboard Directing Prompt Example Source: https://github.com/hbai-ltd/toonflow-app/blob/master/data/skills/art_skills/2D_chinese_guofeng/driector_skills/director_storyboard.md This XML-like structure defines the role of a storyboard artist, character references, continuity rules, a specific shot description, and negative prompts to ensure visual consistency and adherence to the desired aesthetic. ```xml You are an anime storyboard artist. Maintain strict visual continuity across all shots. Image [1]: 古装少女 — 国风二次元造型，典雅服饰，新国潮美学 - Same outfit, hairstyle, face features across ALL shots - Same cel shading style, Japanese animation rendering - Same scene lighting, Chinese anime aesthetic - Do NOT introduce photorealistic or western fantasy elements Medium shot, ancient Chinese girl in elegant traditional attire standing before palace, holding flower branch, gentle expression, soft gaze, cinematic lighting, volumetric fog, depth of field blur, cel shading with fine brushstrokes, Chinese style anime, neo-chic aesthetic, Japanese animation rendering technique, high detail, no subtitles, no captions, no watermark, no title overlay. no photorealistic, no realistic photography, no 3D render, no low-poly, no rough modeling, no plastic texture, no harsh lines, no western fantasy, no cyberpunk, no sci-fi, no modern elements, no cartoon style without anime quality, no subtitles, no captions, no watermark, no title overlay, no UI text ``` -------------------------------- ### AI Image Prompt Generation (Nanobanana Mode) Source: https://github.com/hbai-ltd/toonflow-app/blob/master/data/skills/art_skills/realpeople_ancient_chinese/driector_skills/director_storyboard.md This XML-formatted prompt is tailored for the Nanobanana AI model, emphasizing strict visual continuity. It includes character references, continuity rules, shot descriptions, and negative prompts to guide the AI. ```xml You are a cinematographer and storyboard artist. Maintain strict visual continuity across all shots. Image [1]: 沈辞 — black long hair tied up, calm sharp eyes, dark ancient hanfu robe, tall slim body shape - Same wardrobe, hairstyle, face features across ALL shots - Same environment, lighting style, color grade - Only framing, angle, action, expression may change - Do NOT introduce new characters not in reference images Full shot, character standing atop an ancient city wall, arms resting naturally at his sides, robe hem just beginning to catch the wind with a slight lift, gaze about to turn toward the vast horizon, resolute and composed expression, cold dusk backlight, rim light silhouette, vast landscape below, atmospheric perspective, ancient chinese cinematic realism, ultra-sharp 4K, high detail, crisp textures, photorealistic clarity, no subtitles, no captions, no watermark, no title overlay. no plastic skin, no beauty filter, no studio lighting, no centered composition, no oversaturation, no AI generated look, no motion blur, no noise, no blurry, no out of focus, no subtitles, no captions, no watermark, no title overlay, no UI text ``` -------------------------------- ### Manual Docker Build and Run Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.zhtw.md Manually build the Docker image and run the container, mapping local ports and data paths. Access the web interface via the specified path. ```shell docker build -t toonflow . docker run -d -p <本地埠>:10588 -v <本地資料路徑>:/app/data toonflow # 此時在相應埠的 /web/index.html 路徑即可訪問頁面 # 例如 http://localhost:10588/web/index.html ``` -------------------------------- ### PM2 Service Management Commands Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Commands to start, manage, and monitor the Toonflow application using PM2. Ensure you run 'pm2 startup' and 'pm2 save' after starting the service for persistence. ```bash pm2 start pm2.json pm2 startup pm2 save ``` ```bash pm2 list # View processes pm2 logs toonflow-app # View logs pm2 restart all # Restart services pm2 monit # Monitoring dashboard ``` -------------------------------- ### Package for Windows Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md This command packages the compiled project into a Windows executable. ```bash yarn dist:win ``` -------------------------------- ### Package for macOS Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md This command packages the compiled project into a macOS executable. ```bash yarn dist:mac ``` -------------------------------- ### Ancient Chinese Daily Item Prompt Elements Source: https://github.com/hbai-ltd/toonflow-app/blob/master/data/skills/art_skills/realpeople_ancient_chinese/art_prompt/art_prop.md Example prompt elements for generating ancient Chinese daily items, including type, materials, texture, and style. ```text 茶具/酒具/香炉/棋盘/书卷/灯笼 瓷/铜/竹/木/纸 釉面/木纹/竹节清晰 素雅/华贵按场景切换 古风{器物}，{材质}质感，纹理清晰 ``` -------------------------------- ### Package for Linux Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md This command packages the compiled project into a Linux executable. ```bash yarn dist:linux ``` -------------------------------- ### Run Code Quality Checks Source: https://github.com/hbai-ltd/toonflow-app/blob/master/docs/README.en.md Run this command to perform global syntax and lint checks on the project code. ```bash yarn lint ```