mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
d2a119c38a
* feat: add headless widget for deployment * feat: call callbacks at the right time * feat: add onCallConnected & onCallDisconnected callback * feat: add a button with text for floating widget * feat: add headless widget for deployment * feat: call callbacks at the right time * feat: add onCallConnected & onCallDisconnected callback * feat: add a button with text for floating widget * docs: web widget * fix: format issue in pre-pr drift check * fix: fix CD to rely on pipecat dev dependey * chore: update message --------- Co-authored-by: Abhishek Kumar <abhishek@a6k.me>
119 lines
4.1 KiB
Text
119 lines
4.1 KiB
Text
---
|
|
title: Setup
|
|
description: You can use this document to setup the dev environment for yourself.
|
|
---
|
|
<Note>
|
|
If the below steps do not work out for you, it would be great if you can open an issue on [Github](https://github.com/dograh-hq/dograh/issues).
|
|
</Note>
|
|
|
|
### System Requirements
|
|
- git to clone the forked repository
|
|
- Node.js 24 to run the UI (we recommend using [NVM](https://github.com/nvm-sh/nvm) on macOS/Linux or [NVM for Windows](https://github.com/coreybutler/nvm-windows) on Windows to manage your node versions locally)
|
|
- Python 3.13 to run the backend
|
|
- Docker to run the database and redis cache locally
|
|
|
|
<Note>
|
|
All commands below are shown for **macOS / Linux**. Expand the **Windows** tab for the PowerShell equivalent where it differs.
|
|
</Note>
|
|
|
|
### Steps
|
|
1. Fork the Dograh repository by going to https://github.com/dograh-hq/dograh
|
|
2. Clone the forked repository on your machine (use `--recurse-submodules` so the pipecat submodule is pulled in too)
|
|
```
|
|
git clone --recurse-submodules https://github.com/<GITHUB_HANDLE>/dograh
|
|
cd dograh
|
|
```
|
|
3. Create a python virtual environment
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
```
|
|
```powershell Windows
|
|
python -m venv venv
|
|
.\venv\Scripts\Activate.ps1
|
|
```
|
|
</CodeGroup>
|
|
4. Ensure you are on right version of Node.js using `node --version`
|
|
```
|
|
nvm use 24
|
|
```
|
|
5. Install UI dependencies
|
|
```
|
|
cd ui && npm install && cd ..
|
|
```
|
|
6. Start local docker services
|
|
<Note>Please ensure you dont have any other instance of conflicting services running by checking `docker ps`</Note>
|
|
```
|
|
docker compose -f docker-compose-local.yaml up -d
|
|
```
|
|
Verify that the processes have started by running `docker ps`
|
|
```
|
|
abhishek$ docker ps
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
9066b7244b2f postgres:17 "docker-entrypoint.s…" 18 seconds ago Up 18 seconds (healthy) 0.0.0.0:5432->5432/tcp, [::]:5432->5432/tcp dograh-postgres-1
|
|
6c7cb8afdf18 redis:7 "docker-entrypoint.s…" 18 seconds ago Up 18 seconds (healthy) 0.0.0.0:6379->6379/tcp, [::]:6379->6379/tcp dograh-redis-1
|
|
a57e3e92b02c minio/minio "/usr/bin/docker-ent…" 18 seconds ago Up 18 seconds (healthy) 127.0.0.1:9000-9001->9000-9001/tcp dograh-minio-1
|
|
```
|
|
7. Setup environment variables
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
cp api/.env.example api/.env && cp ui/.env.example ui/.env
|
|
```
|
|
```powershell Windows
|
|
Copy-Item api/.env.example api/.env
|
|
Copy-Item ui/.env.example ui/.env
|
|
```
|
|
</CodeGroup>
|
|
8. Install Python requirements. The script initializes the pipecat submodule, installs `api/requirements.txt`, and installs pipecat with the required extras. Add the dev flag if you also want the pipecat dev dependency group (pytest, ruff, pre-commit, etc.).
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
# Default (runtime only)
|
|
bash scripts/setup_requirements.sh
|
|
|
|
# Include pipecat dev dependencies
|
|
bash scripts/setup_requirements.sh --dev
|
|
```
|
|
```powershell Windows
|
|
# Default (runtime only)
|
|
.\scripts\setup_requirements.ps1
|
|
|
|
# Include pipecat dev dependencies
|
|
.\scripts\setup_requirements.ps1 -Dev
|
|
```
|
|
</CodeGroup>
|
|
9. Start backend services
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
bash scripts/start_services_dev.sh
|
|
```
|
|
```powershell Windows
|
|
.\scripts\start_services_dev.ps1
|
|
```
|
|
</CodeGroup>
|
|
Verify that your backend server is running
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
curl -X GET localhost:8000/api/v1/health
|
|
```
|
|
```powershell Windows
|
|
curl.exe http://localhost:8000/api/v1/health
|
|
```
|
|
</CodeGroup>
|
|
You would be able to see the logs in logs/ directory.
|
|
<CodeGroup>
|
|
```bash macOS/Linux
|
|
tail -f logs/latest/*.log
|
|
```
|
|
```powershell Windows
|
|
Get-Content logs/latest/*.log -Wait
|
|
```
|
|
</CodeGroup>
|
|
10. Start the UI
|
|
```
|
|
cd ui && npm run dev
|
|
```
|
|
11. You should be able to open the application on `localhost:3000` now
|
|
|
|
### Next Steps
|
|
We ship with AGENTS.md and CLAUDE.md which will help the Coding Agents get started quickly with the codebase. This should help your favourite coding agents to be able to navigate the codebase quickly and you can make changes to it and suit your specification better.
|