diff --git a/DEVELOPER_README.md b/DEVELOPER_README.md new file mode 100644 index 0000000..3272308 --- /dev/null +++ b/DEVELOPER_README.md @@ -0,0 +1,9 @@ +# Getting started + +To get a copy of the code and run a test web server: + +1. [Fork the repository](https://github.com/projecthorus/sondehub-tracker/fork) by visiting [https://github.com/projecthorus/sondehub-tracker/fork](https://github.com/projecthorus/sondehub-tracker/fork). +2. Clone the repository with your git tool of choice. +3. Run `build.sh` to compile the javascript files. (This requires Java to be installed and in your path.) +4. Run `python serve.py` to run a simple web server to (This requires python 3.x) +5. Visit [http://localhost:8000](http://localhost:8000) to view the local version of the server!