Use this only if you do not want to use the devcontainer.

System Requirements

  • Git
  • Node.js 24 to run the UI
  • Python 3.13 to run the backend
  • Docker to run Postgres, Redis, and MinIO locally
  1. Run the contributor bootstrap. It configures origin as your fork and upstream as the VR3 AI repository, initializes the pipecat submodule, creates the Python venv, and copies the .env templates.
bash scripts/setup_fork.sh
.\scripts\setup_fork.ps1
  1. Activate the virtual environment:
source venv/bin/activate
.\venv\Scripts\Activate.ps1
  1. Ensure your local Node version is 24:
nvm use 24
  1. Install UI dependencies:
cd ui && npm install && cd ..
  1. Start the local Docker services:
docker compose -f docker-compose-local.yaml up -d
  1. Install Python requirements:
bash scripts/setup_requirements.sh --dev
.\scripts\setup_requirements.ps1 -Dev
  1. Start the backend services:
bash scripts/start_services_dev.sh
.\scripts\start_services_dev.ps1
  1. Start the UI:
cd ui && npm run dev
  1. Open the application on http://localhost:3000.