Cookbook — Dev environment using Docker Compose
This guide will help you quickly set up a local development environment for Buggregator.
1. Clone the Repository
Start by cloning the repository:
git clone git@github.com:buggregator/server.git
cd serverNote: If you don't have access, fork the repository and clone your fork instead.
2. Start with Docker Compose
The repository has a docker-compose.yaml with the Buggregator server and a Laravel example app that sends every kind of event.
docker compose up --buildThis will:
- Build the Buggregator image from the
Dockerfile - Start the Buggregator server
- Start the example app for testing features
The example app mounts code from an
examplescheckout next toserver(../examples/app,../examples/routes,../examples/resources,../examples/config/sentry.php). Clone it first:bashgit clone git@github.com:buggregator/examples.git ../examples
The compose file mounts
../frontend/distand setsFRONTEND_DIR, so the server serves a frontend build from afrontendcheckout next toserver. Build it there first (yarn install && yarn build:prod), or remove those two lines to use the embedded UI.
3. Access the Application
Once the server is up:
- Buggregator: http://localhost:8000
- Example app: http://localhost:8080
4. Development without Docker
If you prefer to develop without Docker, you need:
- Go 1.26+
- Make
- PHP and Composer —
make buildcompiles the VarDumper parser fromphp/vardumperthe first time. The server itself does not need PHP to run.
# Build and run
make build
make run
# Or just compile
go build ./cmd/buggregator
# Run tests
go test ./...Frontend Development
The frontend is a pre-built SPA that gets embedded into the binary during the build process. To develop the frontend separately:
git clone git@github.com:buggregator/frontend.git
cd frontend
yarn install
yarn build:prod # writes the build to dist/Then let Buggregator serve that build instead of the embedded one:
FRONTEND_DIR=/path/to/frontend/dist ./buggregatorFor live reload while you work on the UI, see Contributing → Frontend.
5. Stop the Server
# If using Docker Compose
docker compose down
# If running directly
Ctrl+CThat's it! Your Buggregator dev environment is ready.