From 04163a2d5069fa0cfaccf0ffb6d060207e4a86d7 Mon Sep 17 00:00:00 2001 From: Shubham-Chaprana Date: Sun, 18 Jan 2026 17:44:33 +0530 Subject: [PATCH] Docs: add Windows Docker setup notes --- docs/developer/setup.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/docs/developer/setup.md b/docs/developer/setup.md index c4730fc0..ddedd065 100644 --- a/docs/developer/setup.md +++ b/docs/developer/setup.md @@ -19,6 +19,10 @@ Have these installed first before continuing further. - Docker - Docker compose - GNU Make + +!!! note "Windows users" + If you don't have `make` installed, you can still run the project using `docker compose` commands directly (see below). + - GitHub CLI (optional, but recommended) https://cli.github.com/ ### Starting the local env @@ -41,11 +45,36 @@ Have these installed first before continuing further. 3. Start the local environment: +=== "Using Make (recommended)" + + ```sh + make serve + ``` + +=== "Without Make" + + ```sh + docker compose up --build + ``` + + +4. Open the browser and go to to see the app running. + + +### First-time setup + +After starting the containers for the first time, apply database migrations: + ```sh -make serve +docker compose exec web python manage.py migrate ``` -4. Open the browser and go to to see the app running. +If you see an error like `relation "stats_cache_table" does not exist`, create the database cache table: + +```md +``` sh +docker compose exec web python manage.py createcachetable stats_cache_table +``` 5. Run the tests: