From 2028cbbe6175e2e180f98c0fdde4938b56a06ec4 Mon Sep 17 00:00:00 2001 From: Matt Way Date: Sat, 17 Aug 2024 22:19:35 +1000 Subject: [PATCH] Update map-generator readme --- map-generator/readme.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/map-generator/readme.md b/map-generator/readme.md index 8cd0e05..438e513 100644 --- a/map-generator/readme.md +++ b/map-generator/readme.md @@ -1,9 +1,13 @@ # Map Generator -This project is displays a map showing the boundaries of wards within a single local government area. Each ward is labelled. +This project displays a map showing the boundaries of wards within a single local government area. Each ward is labelled. The data for this comes from the VEC Map API: https://maps.vec.vic.gov.au/api/electorates/4/withboundaries -To compile the `src.js` file after every edit, run `webpack-cli --mode development --watch` in this folder. +To allow the page to download the `wards_withboundaries.json` file, the page needs to be accessed via a `http://` URL (and not a `file:///` URL). One easy way to do this is with the web server built into Python, it can be started by running `python3 -m http.server` in this folder. + +To tell the page which council to load, add a query parameter to the URL eg. `?council=brimbank` or `?council=Melbourne%20City%20Council` + +To automatically compile the `src.js` file after every edit, run `webpack-cli --mode development --watch` in this folder. Changes to `dist/main.js` should be committed so that other users don't need to install node. \ No newline at end of file