From 395e91a81bd7ccf9138d79a43a6775a7d482bd8b Mon Sep 17 00:00:00 2001 From: Sam Wilson Date: Sun, 21 Apr 2024 20:36:57 +1000 Subject: [PATCH] Added setup docs --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 63b1a6f..eac9ea1 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,17 @@ Accepts the following GET parameters. |---|----|---|---| |lon|Float|134.9|Sets the map center longitutde.| |lat|Float|-28.2|Sets the map center latitude.| -|zoom|Float|4.3|Sets the map center zoom.| \ No newline at end of file +|zoom|Float|4.3|Sets the map center zoom.| + +## Contributing + +### Dependencies + +* [Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) + +### Running the map + +1. Checkout the code. +1. `npm -i` +1. `npm run serve` +1. Open [http://localhost:8080/](http://localhost:8080/) \ No newline at end of file