2025-12-27 09:25:20 +05:30
---
title: Setup
2026-05-25 20:44:22 +05:30
description: Set up the Dograh contributor environment with the devcontainer-first workflow.
2025-12-27 09:25:20 +05:30
---
<Note>
2026-05-25 20:44:22 +05:30
If the steps below do not work for you, please open an issue on [GitHub](https://github.com/dograh-hq/dograh/issues).
2025-12-27 09:25:20 +05:30
</Note>
2026-05-25 20:44:22 +05:30
### Recommended: Devcontainer Setup
2025-12-27 09:25:20 +05:30
2026-05-25 20:44:22 +05:30
#### System Requirements
- Git
- Docker Desktop or another local Docker engine
- For the IDE path: VS Code with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
- For the terminal-only path: Node.js on your host so you can install the Dev Container CLI
2026-04-03 06:34:13 +05:00
2026-05-25 20:44:22 +05:30
1. Fork the Dograh repository at https://github.com/dograh-hq/dograh
2. Clone **your fork**:
```bash
2026-05-12 14:25:34 +05:30
git clone https://github.com/<GITHUB_HANDLE>/dograh
2025-12-27 09:25:20 +05:30
cd dograh
```
2026-05-25 20:44:22 +05:30
3. Start the devcontainer.
2026-05-07 12:23:41 +05:30
2026-05-25 20:44:22 +05:30
In VS Code, open the repository and run **Dev Containers: Reopen in Container**.
2026-05-07 12:23:41 +05:30
2026-05-25 20:44:22 +05:30
Without an IDE, use the Dev Container CLI:
```bash
npm install -g @devcontainers/cli
devcontainer up --workspace-folder .
devcontainer exec --workspace-folder . bash
2026-04-03 06:34:13 +05:00
```
2026-05-25 20:44:22 +05:30
4. Wait for the first build to finish. The first build takes several minutes; subsequent opens are much faster.
5. Start the backend from a terminal inside the container:
```bash
2026-05-12 13:54:33 +05:30
bash scripts/start_services_dev.sh
```
2026-05-25 20:44:22 +05:30
Without an IDE, run the same command from your host:
```bash
devcontainer exec --workspace-folder . bash scripts/start_services_dev.sh
2025-12-27 09:25:20 +05:30
```
2026-05-25 20:44:22 +05:30
6. Start the UI from another terminal inside the container:
2026-05-12 14:25:34 +05:30
```bash
2026-05-25 20:44:22 +05:30
cd ui
npm run dev -- --hostname 0.0.0.0
2026-05-12 14:25:34 +05:30
```
2026-05-25 20:44:22 +05:30
Without an IDE, use another host terminal:
```bash
devcontainer exec --workspace-folder . bash -lc 'cd ui && npm run dev -- --hostname 0.0.0.0'
2026-05-12 14:25:34 +05:30
```
2026-05-25 20:44:22 +05:30
7. Verify that the backend is healthy:
```bash
curl -X GET localhost:8000/api/v1/health
2026-05-12 14:25:34 +05:30
```
2026-05-25 20:44:22 +05:30
8. Open the app at `http://localhost:3000`.
2026-05-12 14:25:34 +05:30
2026-05-25 20:44:22 +05:30
### More Setup Options
2025-12-27 09:25:20 +05:30
2026-05-25 20:44:22 +05:30
- For what the devcontainer bootstrap does, rebuild guidance, logs, and personal install hooks, see [Devcontainer Workflow](/contribution/devcontainer).
- If you cloned `dograh-hq/dograh` directly instead of your fork, see [Fork Workflow](/contribution/fork-workflow) to reset `origin` and `upstream`.
- If you do not want to use the devcontainer, see [Host-managed Setup](/contribution/host-managed-setup).