From c7b81793468df5a60b6fe0c71750943178267dfe Mon Sep 17 00:00:00 2001 From: John Yeo <51376134+johnyeocx@users.noreply.github.com> Date: Tue, 24 Jun 2025 12:58:27 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 37b37c98c..a896b499e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -68,7 +68,9 @@ The `setup` script generates required environment variables to run Autumn locall #### Step 3: Start Development Environment ```bash -docker compose -f docker-compose.dev.yml up +docker compose -f docker-compose.dev.yml up # (if on windows) +# or +docker compose -f docker-compose.dev.yml up # (if on mac / linux) ``` ### Manual Setup @@ -129,4 +131,4 @@ When you need to create version-controlled migrations (e.g., for new releases): The `docker-compose.dev.yml` runs localtunnel using your `LOCALTUNNEL_RESERVED_KEY` as the subdomain. If using alternative tunneling (ngrok, cloudflared), ensure it points to port 8080 and update `STRIPE_WEBHOOK_URL` accordingly. ### Database -- `DATABASE_URL` - PostgreSQL connection string --> \ No newline at end of file +- `DATABASE_URL` - PostgreSQL connection string -->