From 5d8f46b3c2f9998225a807f173fb4783207a080a Mon Sep 17 00:00:00 2001 From: Pieter Vander Vennet Date: Wed, 5 Feb 2025 14:58:40 +0100 Subject: [PATCH] Docs: explain the flow to test local theme changes --- Docs/Development_deployment.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Docs/Development_deployment.md b/Docs/Development_deployment.md index 8beafc0a09..896ef0ec05 100644 --- a/Docs/Development_deployment.md +++ b/Docs/Development_deployment.md @@ -80,10 +80,22 @@ To use the WSL in Visual Studio Code: or `userlayout=true#` as [Query parameter](URL_Parameters.md). Note that the shorter URLs ( e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version. + +Developing a local theme +------------------------ + +To test theme changes you locally make, the easiest way is: + +- `npm run strt` which will run the server +- After making changes to some layers and/or themes, run `npm run generate:layeroverview`. This will recompile the relevant themes. +- You might need to refresh (F5) your browser window + +Note that `npm run strt` is equivalent to `npm run generate:layeroverview && npm run strt` + Automatic deployment -------------------- -Currently, the master branch is automatically deployed to https://mapcomplete.org/ by a GitHub action. +Currently, the master branch is automatically deployed to https://mapcomplete.org/ by a Forgejo action. Every branch is automatically built (upon push) to `https://pietervdvn.github.io/mc/` by a GitHub action.