feat: docker-compose setup

Author: radim

Dockerfile

@@ -0,0 +1,14 @@
+FROM golang:1.23-alpine AS builder
+WORKDIR /app
+COPY go.mod go.sum ./
+RUN go mod download
+COPY . .
+RUN CGO_ENABLED=0 GOOS=linux go build -o pg-storage-visualizer ./cmd/pg-storage-visualizer
+
+FROM alpine:latest
+RUN apk --no-cache add ca-certificates
+WORKDIR /app
+COPY --from=builder /app/pg-storage-visualizer .
+EXPOSE 8080
+ENV DATABASE_URL=postgres://postgres:postgres@db:5432/demo?sslmode=disable
+ENTRYPOINT ["./pg-storage-visualizer"]

README.md

@@ -27,6 +27,24 @@ make build
 open http://localhost:8080
 ```
 
+## Docker
+
+```bash
+docker-compose up --build
+```
+
+| Service    | URL                                                  |
+|------------|------------------------------------------------------|
+| Visualizer | http://localhost:8080                                |
+| PostgreSQL | `postgres://postgres:postgres@localhost:5433/demo`   |
+
+Includes demo tables (`demo`, `hot_demo`) and required extensions pre-loaded.
+
+```bash
+# psql into the container
+docker-compose exec db psql -U postgres demo
+```
+
 ## Build Dependencies
 
 [templ](https://templ.guide/) - HTML templating for Go:

docker-compose.yml

@@ -0,0 +1,26 @@
+services:
+  db:
+    image: postgres:16-alpine
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: demo
+    volumes:
+      - ./init.sql:/docker-entrypoint-initdb.d/init.sql
+    ports:
+      - "5433:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 2s
+      timeout: 5s
+      retries: 10
+
+  app:
+    build: .
+    ports:
+      - "8080:8080"
+    environment:
+      DATABASE_URL: postgres://postgres:postgres@db:5432/demo?sslmode=disable
+    depends_on:
+      db:
+        condition: service_healthy

init.sql

@@ -0,0 +1,31 @@
+-- Enable required extensions
+CREATE EXTENSION IF NOT EXISTS pageinspect;
+CREATE EXTENSION IF NOT EXISTS pgstattuple;
+
+-- Demo table for bloat demonstration
+CREATE TABLE demo (
+    id integer PRIMARY KEY,
+    name text,
+    status text
+);
+
+INSERT INTO demo
+SELECT i, 'item_' || i, 'active'
+FROM generate_series(1, 50000) i;
+
+-- HOT update demo table
+CREATE TABLE hot_demo (
+    id integer PRIMARY KEY,
+    indexed_col text,
+    hot_col text
+);
+
+CREATE INDEX ON hot_demo(indexed_col);
+
+INSERT INTO hot_demo
+SELECT i, 'indexed_' || i, 'hot_' || i
+FROM generate_series(1, 1000) i;
+
+-- Analyze tables for accurate stats
+ANALYZE demo;
+ANALYZE hot_demo;