Introduction

Get the Hallo Stroke platform running locally.

The Hallo Stroke platform has three repos:

Component	Repo	Stack
Frontend	`hallo-stroke-bunny`	React 18 + nginx
Backend	`Hallo-Stroke-Backend`	Go 1.24 + GoFiber
Database	(in backend compose)	PostgreSQL 18

Prerequisites

Go 1.24+ (backend)
Node 24+ and npm (frontend — CRA; or bun)
Docker + docker-compose (recommended path)
A PostgreSQL 18 instance (or use the backend's docker-compose db service)
API keys: GOOGLE_MAPS_API_KEY, YOUTUBE_API_KEY
A WhatsApp gateway reachable at WHATSAPP_API_ENDPOINT

Easiest path: Docker

The backend ships a docker-compose.yml that spins up Postgres + the API together. See Deployment → Docker.

Quick start (Docker)

git clone <hallo-stroke-bunny>
git clone <Hallo-Stroke-Backend>

cd Hallo-Stroke-Backend
cp .env.example .env   # fill in secrets
docker compose up -d

The API runs on :3001, Postgres on the compose network.

cd hallo-stroke-bunny
cp .env.development .env
npm install
npm start   # CRA dev server, :3000

Or build the nginx image: docker compose up -d (serves on :3003).

Backend health: GET http://localhost:3001/health
Swagger UI: http://localhost:3001/swagger
Frontend: http://localhost:3000

See Environment for every variable you need to fill in.

Notifications

Web Push (VAPID) subscriptions and delivery.

Environment Variables

All configuration variables for frontend and backend.

On this page

Prerequisites Quick start (Docker)