Get VoiceForge running on your local machine in minutes.
Prerequisites
1
Python 3.10 or higher
2
Node.js 18+ (for the UI)
3
FFmpeg installed and added to PATH
Step 1: Clone the Repository
# Clone with git git clone https://github.com/Ayushpani/voiceforge.git cd voiceforge
Step 2: Backend Setup (Python)
The backend handles all AI inference. It requires a dedicated python environment.
1. Create Environment
# Check your python version first (Must be 3.10+) python --version
# Create virtual environment python -m venv venv
2. Activate & Install
# Windows Activation .\venv\Scripts\activate # (You should see (venv) in your terminal now)
# Install dependencies (This may take a few minutes) pip install -r requirements.txt
Step 3: Frontend Setup (Next.js)
The frontend provides the web interface.
cd frontend
# Install node modules npm install
Step 4: Model Access (Important)
VoiceForge uses models from Hugging Face that may require acceptance of terms (e.g., Pyannote/SpeechBrain). You need a Hugging Face Access Token (Read-only).
Authenticate
# In the backend directory: python hf_login.py # Paste your token when prompted.
Alternatively, set the HF_TOKEN environment variable.
Troubleshooting
"Pip install failed on wheels"
Ensure you have C++ Build Tools installed if you are on Windows. Some audio libraries require compilation.
"FFmpeg not found"
Run ffmpeg -version in your terminal. If it fails, download FFmpeg and add the `bin` folder to your System PATH environment variable.
That's it!
You are now ready to run the application. Head over to the Quick Start guide.