Bucketlist API (Challenge 3)

This project is an API for a bucketlist app, that enables you to keep track of your goals or dreams.

How to run the app

To run this project, you will need Python 3 installed on your computer.

Install virtualenv and virtualenvwrapper.
Clone the repository using git clone https://github.com/john555/bucketlist-api.git.
Cd into the root the project root folder using cd <folder_name>.
Create a virtual environment using using mkvirtual <virtual_environment_name>.
Activate the virtual environment using workon <virtual_environment_name> if it isn't activated.
Install required packages using pip install -r requirements.txt.
Create a database using postgresql and set DATABASE_URL as an environment variable. This is the database connection string.
Set APP_SECRET as environment variable. This should be a long secret key.
Set REQUESTS_ORIGIN as an environment variable. This is the domain from which the API will be consumed.
Run the app using the python run.py command.

For more info on what commands are available, run python dbmigration.py db --help

The tests are written using the unittest module. To execute tests,

Run nosetests --with-coverage --cover-package=bucketlist from the root folder of the project.
Alternatively you can run python -m unittest.

Note: Make sure to install all required dependencies and configure the app environment.

Documentation can be found at /apidocs when the app is running.