docs/RUN_FROM_GITHUB.md

🚀 How to Run VoiceForge from GitHub

Follow these steps to set up and run the VoiceForge platform on your local machine.

1. Clone the Repository

git clone https://github.com/lordofgamingfake-web/VoiceForge.git
cd VoiceForge

2. Backend Setup (Python)

Create Virtual Environment

# Windows
python -m venv .venv
.\.venv\Scripts\activate

# Linux/macOS
python3 -m venv .venv
source .venv/bin/activate

Install Dependencies

pip install -r backend/requirements.txt

Configure Environment

Copy the example environment file and adjust if necessary:

cp .env.example .env

The default .env is configured for SQLite and Local Services (Whisper/EdgeTTS) so you can run it immediately without external databases.

Run the Server

uvicorn app.main:app --app-dir backend --reload

API will be available at: http://localhost:8000 Swagger Docs: http://localhost:8000/docs

---

3. Frontend Setup (React)

cd frontend
npm install
npm run dev

---

4. Docker (Easiest Way)

If you have Docker installed, you can run everything with one command:

docker-compose up --build

---

5. Mobile App (Flutter)

Ensure you have Flutter installed:

cd mobile
flutter pub get
flutter run

---

📖 Detailed Documentation

For Kubernetes, Terraform, and Production monitoring, see docs/DEPLOYMENT_GUIDE.md.