From df3f91593ae705f5b8389c0635d03fb36e27bb1e Mon Sep 17 00:00:00 2001 From: fspecii Date: Wed, 4 Feb 2026 03:20:03 +0200 Subject: [PATCH] Add Windows support: setup.bat and start.bat for Windows users --- README.md | 42 +++++++++++++++++++++++++++++- setup.bat | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++ start.bat | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 190 insertions(+), 1 deletion(-) create mode 100644 setup.bat create mode 100644 start.bat diff --git a/README.md b/README.md index 93fbb0b..c943b88 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,7 @@ ## ⚡ Quick Start +### Linux / macOS ```bash # 1. Start ACE-Step API (in ACE-Step directory) cd /path/to/ACE-Step @@ -157,6 +158,17 @@ cd ace-step-ui ./start.sh ``` +### Windows +```batch +REM 1. Start ACE-Step API (in ACE-Step directory) +cd C:\path\to\ACE-Step +uv run acestep-api --port 8001 + +REM 2. Start ACE-Step UI (in another terminal) +cd ace-step-ui +start.bat +``` + Open **http://localhost:3000** and start creating! --- @@ -180,6 +192,7 @@ cd .. ### 2. Install ACE-Step UI (This Repository) +#### Linux / macOS ```bash # Clone the UI git clone https://github.com/fspecii/ace-step-ui @@ -189,7 +202,17 @@ cd ace-step-ui ./setup.sh ``` -**Or install manually:** +#### Windows +```batch +REM Clone the UI +git clone https://github.com/fspecii/ace-step-ui +cd ace-step-ui + +REM Run setup script (installs all dependencies) +setup.bat +``` + +#### Manual Installation (All Platforms) ```bash # Install frontend dependencies @@ -201,7 +224,10 @@ npm install cd .. # Copy environment file +# Linux/macOS: cp server/.env.example server/.env +# Windows: +copy server\.env.example server\.env ``` --- @@ -210,20 +236,34 @@ cp server/.env.example server/.env ### Step 1: Start ACE-Step API Server +**Linux / macOS:** ```bash cd /path/to/ACE-Step uv run acestep-api --port 8001 ``` +**Windows:** +```batch +cd C:\path\to\ACE-Step +uv run acestep-api --port 8001 +``` + Wait for "Application startup complete" before proceeding. ### Step 2: Start ACE-Step UI +**Linux / macOS:** ```bash cd ace-step-ui ./start.sh ``` +**Windows:** +```batch +cd ace-step-ui +start.bat +``` + ### Step 3: Create Music! | Access | URL | diff --git a/setup.bat b/setup.bat new file mode 100644 index 0000000..2afc3c8 --- /dev/null +++ b/setup.bat @@ -0,0 +1,73 @@ +@echo off +REM ACE-Step UI Setup Script for Windows +setlocal enabledelayedexpansion + +echo ================================== +echo ACE-Step UI Setup (Windows) +echo ================================== +echo. + +REM Check Node.js +where node >nul 2>&1 +if %ERRORLEVEL% NEQ 0 ( + echo Error: Node.js not found! + echo Please install Node.js 18+ from https://nodejs.org/ + pause + exit /b 1 +) + +REM Show Node version +for /f "tokens=*" %%i in ('node --version') do echo Node.js version: %%i + +REM Install frontend dependencies +echo. +echo Installing frontend dependencies... +call npm install +if %ERRORLEVEL% NEQ 0 ( + echo Error: Failed to install frontend dependencies + pause + exit /b 1 +) + +REM Install server dependencies +echo. +echo Installing server dependencies... +cd server +call npm install +if %ERRORLEVEL% NEQ 0 ( + echo Error: Failed to install server dependencies + cd .. + pause + exit /b 1 +) +cd .. + +REM Create server .env if it doesn't exist +if not exist "server\.env" ( + echo. + echo Creating server\.env from example... + copy server\.env.example server\.env +) + +REM Create data directory +if not exist "server\data" ( + mkdir server\data +) + +echo. +echo ================================== +echo Setup Complete! +echo ================================== +echo. +echo Next steps: +echo. +echo 1. Start ACE-Step API (in ACE-Step folder): +echo cd path\to\ACE-Step +echo uv run acestep-api --port 8001 +echo. +echo 2. Start ACE-Step UI: +echo start.bat +echo. +echo 3. Open http://localhost:3000 +echo. +pause diff --git a/start.bat b/start.bat new file mode 100644 index 0000000..c0055b7 --- /dev/null +++ b/start.bat @@ -0,0 +1,76 @@ +@echo off +REM ACE-Step UI Startup Script for Windows +setlocal + +echo ================================== +echo ACE-Step UI (Windows) +echo ================================== +echo. + +REM Check if node_modules exists +if not exist "node_modules" ( + echo Error: Dependencies not installed! + echo Please run setup.bat first. + pause + exit /b 1 +) + +if not exist "server\node_modules" ( + echo Error: Server dependencies not installed! + echo Please run setup.bat first. + pause + exit /b 1 +) + +REM Get local IP for LAN access +for /f "tokens=2 delims=:" %%a in ('ipconfig ^| findstr /c:"IPv4"') do ( + for /f "tokens=1" %%b in ("%%a") do ( + set LOCAL_IP=%%b + ) +) + +echo Starting ACE-Step UI... +echo. +echo Make sure ACE-Step API is running: +echo cd path\to\ACE-Step +echo uv run acestep-api --port 8001 +echo. +echo ================================== +echo. + +REM Start backend in new window +echo Starting backend server... +start "ACE-Step UI Backend" cmd /k "cd server && npm run dev" + +REM Wait for backend to start +echo Waiting for backend to start... +timeout /t 3 /nobreak >nul + +REM Start frontend in new window +echo Starting frontend... +start "ACE-Step UI Frontend" cmd /k "npm run dev" + +REM Wait a moment +timeout /t 2 /nobreak >nul + +echo. +echo ================================== +echo ACE-Step UI Running! +echo ================================== +echo. +echo Frontend: http://localhost:3000 +echo Backend: http://localhost:3001 +echo. +if defined LOCAL_IP ( + echo LAN Access: http://%LOCAL_IP%:3000 + echo. +) +echo Close the terminal windows to stop. +echo. +echo ================================== +echo. +echo Opening browser... +timeout /t 2 /nobreak >nul +start http://localhost:3000 + +pause