First push to GitHub

README.md

@@ -0,0 +1,32 @@
+## Requirements
+ 
+- pipenv
+- MongoDB
+- Python 3 (defaults to Python 3.7, but you can change this in the Pipfile before setup)
+
+## Setup instructions
+
+1. Clone this repo to your local web server
+2. `cd` into the directory within the terminal
+3. Run `./setup.sh` to setup pipenv and configure the Flask app
+
+## Running the app
+
+1. Run `pipenv shell` to activate the virtual environment
+2. Run `./run.sh` to start the Flask application
+
+## Further configuration
+
+You can configure the app manually by editing the `api/main/config/config.cfg` file.
+
+## Auth tokens
+
+There is a very basic front-end example in place within the `/web` directory. It demonstrates making a few API calls (User Add and User Login).
+
+A successful login request will return two tokens: `AccessToken` and `RefreshToken`. These should be saved to localStorage and used to set the `AccessToken` and `RefreshToken` request headers for all protected routes (e.g. `GET /user/`).
+
+You can refresh the `AccessToken` when it returns as expired by submitting a request to `GET /user/auth/`.
+
+## Notes
+
+Please excuse the brief instructions. I've only run this in my own environment (MacOS, Python 3.7, MongoDB 4.0.4, pipenv 2018.11.14) so it may not run out of the box on your computer, but I'd be happy to help debug if you get stuck. Reach out on Twitter [@MoonlightLuke](https://twitter.com/MoonlightLuke)