Host-managed Setup

​

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 ringlyra-hq/ringlyra, initializes the pipecat submodule, creates the Python venv, and copies the .env templates.

bash scripts/setup_fork.sh

.\scripts\setup_fork.ps1

2. Activate the virtual environment:

source venv/bin/activate

.\venv\Scripts\Activate.ps1

3. Ensure your local Node version is 24:

nvm use 24

4. Install UI dependencies:

cd ui && npm install && cd ..

5. Start the local Docker services:

docker compose -f docker-compose-local.yaml up -d

6. Install Python requirements:

bash scripts/setup_requirements.sh --dev

.\scripts\setup_requirements.ps1 -Dev

7. Start the backend services:

bash scripts/start_services_dev.sh

.\scripts\start_services_dev.ps1

8. Start the UI:

cd ui && npm run dev

9. Open the application on http://localhost:3000.