From 2b08f81c8dd68f10ababf0a0983ec9d5ef241366 Mon Sep 17 00:00:00 2001 From: Ryan Chen Date: Thu, 14 May 2026 22:57:24 -0400 Subject: [PATCH] Add README with build and deploy instructions Co-Authored-By: Claude Opus 4.6 --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc1df33 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# bbq + +Potluck signup app. No accounts — share a link, people claim slots. + +## Run locally + +``` +go build -o bbq . && ./bbq +``` + +Listens on `:8080`. Set `PORT` and `BBQ_DB` env vars to override. + +## Docker + +``` +docker compose up -d --build +``` + +Runs on `127.0.0.1:8090`. Data persists in a `bbq-data` volume. + +## Reverse proxy (Caddy) + +``` +bbq.example.com { + reverse_proxy localhost:8090 +} +``` + +## Regenerate DB layer + +``` +$(go env GOPATH)/bin/sqlc generate +```