Getting Started

Prerequisites

• A VPS running Ubuntu 24.04 LTS (Hetzner, DigitalOcean, or similar)
• Docker Engine and Docker Compose v2 installed on the VPS
• A domain name registered with Porkbun and proxied through Cloudflare
• SSH access to the VPS
• Git installed locally and on the VPS

Clone the Repo

On the VPS:

mkdir -p /opt/weekendbuilder
cd /opt/weekendbuilder
git clone git@github.com:YOUR_ORG/weekendbuilder-platform.git platform
cd platform

First Deploy

chmod +x scripts/deploy-landing.sh
./scripts/deploy-landing.sh

This creates the web Docker network, starts Traefik (with Let’s Encrypt), and brings up the landing page at https://weekendbuilder.io.

Deploying the Docs Site

chmod +x scripts/deploy-docs.sh
./scripts/deploy-docs.sh

This builds the Astro Starlight site inside Docker and serves it at https://docs.weekendbuilder.io.

Adding a New App

Every app follows the same four-step pattern:

1. Add your app under apps/<name>/ with a Dockerfile and docker-compose.yml
2. Attach the service to the web Docker network (external)
3. Add Traefik labels: Host(...), entrypoint websecure, cert resolver letsencrypt
4. Add a deploy script at scripts/deploy-<name>.sh

See Landing Page Deployment for a worked example.