Skip to content
quickstart · 8 min

Quickstart — your first service in 10 minutes

Run a service locally with Docker Compose and hit its API.

1 Pick a service

Every service ships as a Docker image with a canonical docker-compose.yml. Start with the one closest to your problem — Flytrap if you need a webhook catcher, Parachute for an auto-CMS, Stash for a Redis GUI.

2 Pull and run

Every service ships as a public Docker image. A ready-to-go compose stack with Redis, MinIO, and a database lives alongside the image for local development.

docker pull baseblox/flytrap:latest
docker compose -f compose.flytrap.yml up -d

3 Hit the health endpoint

Every service exposes GET /up for liveness and GET /openapi for a complete API spec. Swagger UI lives at /swagger/.

curl http://localhost:8080/up
# {"status":"ok","uptime":"3s","version":"1.x"}

4 Authenticate

Set SHARED_WS_KEY in .env and use it as a bearer token for the REST API and a query/header for the WebSocket.

5 Next

Skim the platform contract to see the runtime conventions every service follows. Then deploy another — the conventions are the same.

Keep reading

Related guides

The platform contract — one runtime, every service

The runtime, API, WebSocket, queue, and storage contract every service follows.

Deploying to Kubernetes

Each service ships a Helm chart with production-safe defaults.

Webhook integration patterns

Reliable, debuggable webhook delivery between services.
Ready when you are

Ship the blocks. Focus on the product.

Docker-ready microservices you can deploy in an afternoon. Learn one, use them all.

See pricing Browse products