matt/spl-tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update map-generator readme

Browse Source
This commit is contained in:
Matt Way
2024-08-17 22:19:35 +10:00
parent e1a1ff4af3
commit 2028cbbe61
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
map-generator/readme.md
View File

@@ -1,9 +1,13 @@
# Map Generator # 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 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. Changes to `dist/main.js` should be committed so that other users don't need to install node.