To run Dittofeed locally, start docker compose, build the dashboard, and then run the development bootstrap script.
docker compose up -d # Builds all of the dashboard dependencies including those required by the # bootstrap script, then runs bootstrap. ./dev-setup.sh
Then run the service components in separate terminal windows.
yarn workspace dashboard dev yarn workspace api dev # Optionally yarn workspace worker dev
yarn admin <cmd> [args] invoke’s the
admin-cli package’s CLI, located here. The
admin-cli provides useful commands for local development as well as operational tasks in production.
Running with Github Codespaces
Running Dittofeed with Github Codespaces is an easy way to set up a development environment, as they can help rule out idiosyncratic issues with your local environment.
To open a codespace, open vscode, and navigate to the Remote Explorer tab. Then click on the “Open Codespace” button.
From here, select the dittofeed repository, and create a codespace. We recommend using the second tier codespace or higher, to ensure you have enough resources to run the application (4 cores, 8 GB RAM, 32 GB storage).
Running Locally With OpenTelemetry
In order to run Dittofeed locally with OpenTelemetry (OTEL), start the API or dashboard with the following environment variables.
START_OTEL=true yarn workspace dashboard dev
Then run the docker compose dependencies with the otel profile.
docker compose --profile otel up -d