Getting Started

Prerequisites

You only need two things installed on your machine:

• Docker — docs.docker.com/get-docker
• Docker Compose (included with Docker Desktop, or install the docker-compose-plugin separately on Linux)

You do not need Go, Node.js, or PostgreSQL installed locally.

Local Development

1. Clone the repository

   git clone https://github.com/notfixingit3/waffle.git
   cd waffle

2. Start everything

   docker compose up --build

   Docker Compose will:

   • Build the Go application (multi-stage)
   • Start PostgreSQL 16
   • Run all database migrations automatically
   • Inject safe local-development defaults (DB connection, JWT secret, admin credentials)

   You do not need to create a .env file for local development.

3. Open the app

   Service	URL
   Public application	http://localhost:8383
   Admin login	http://localhost:8383/admin/login
   Health check	http://localhost:8383/health
   PostgreSQL	localhost:5432

Default Credentials

To use a different password in local dev, pass it as an environment variable:

ADMIN_PASSWORD=mypassword docker compose up --build

What's Running

The docker compose up command starts two containers:

• app — the Go binary serving HTTP on port 8383
• postgres — PostgreSQL 16 on port 5432, database name syrup

The Go app waits for PostgreSQL to be healthy before starting, then runs all pending migrations from backend/migrations/ automatically. A seed waffle and admin are inserted on a fresh database so the app is useful immediately.

First Steps After Login

After logging in to /admin/login with the default credentials:

1. Change your password — click your username in the top-right → Settings → Change Password.
2. Set your timezone — on the same Settings page, choose your IANA timezone from the dropdown so waffle timestamps appear correctly.
3. Create your first real waffle — click New Waffle on the admin dashboard.
4. Share the public link — the public URL is http://<your-domain>/waffle/<slug>. Post it in your Instagram story or DM it to your buyers.

Install as a PWA

Project Syrup ships a Web App Manifest and service worker, so it can be installed as a Progressive Web App on iOS and Android. Buyers can add the waffle page to their home screen for a native-app feel.

• iOS (Safari): Share → Add to Home Screen
• Android (Chrome): Menu → Add to Home Screen / Install App

PWA installation and service worker offline caching require HTTPS in production. Local localhost is a secure context and works without HTTPS.

Stopping the App

# Stop containers (data is preserved)
docker compose down

# Stop and wipe all data (fresh start)
docker compose down -v