The api enables you to create/ register a user within the application.

• Checkout my Post on how to deploy this application to Heroku

• I wrote up a post on medium of how I developed this API, you can find it here

In order to run the application set the environment variable below.

Windows
set FLASK_APP=run.py

Unix
export FLASK_APP=run.py

Then run the command below to start the application.

flask run

The api documentation is hosted as the homepage of the application.

Before running the application tests, update your env variables

export  APP_SETTINGS=app.config.TestingConfig
export DATABASE_URL_TEST=<postgres database url>

You can now run the tests from the terminal

python manage.py test

You can also run tests with coverage by running this command in the terminal

nosetests --with-coverage --cover-package=app