live-it is a bucket list RESTful API that allows creating and editing of bucket lists -- These are a number of experiences or achievements that a person hopes to have or accomplish during their lifetime.
A quick demo can be viewed here

1. Flask
2. Flask-SQLAlchemy
3. Python 2.7
4. flask_httpauth
5. flask_restful
6. flask_testing

• Navigate to your directory choice

• Clone the repository:

• Using SSH:
  git@github.com:andela-jmuli/live-it.git

• Using HTTP
  https://github.com/andela-jmuli/live-it.git

• Setup a virtualenvironment for dependencies:

  • virtualenv {{ desired name }}
  • Activate your environment

• cd into folder and run source bin/activate to activate the virtual environment

• Install the dependencies:

  • pip install -r reqiuirements.txt

• cd back to the project root

• Setup the database tables and migrations:

  • python manage.py db init
  • python manage.py db migrate
  • python manage.py db upgrade

• Run the server via:

  • python manage.py runserver

• you may user Chrome's extension Postman to view or use api

Registering a new user:
Ensure the URL points to http://localhost:5000/api/v1/auth/register/ as a POST request:
This is a parameterized request thus you need to provide a name and password

.

Authenticating a user (Login) Ensure the URL points to http://localhost:5000/api/v1/auth/login/ as a POST request:
This is a parameterized request thus you need to provide a name and password

Creating a Bucketlist: Ensure the URL points to http://localhost:5000/api/v1/bucketlists/ as a POST request. This is a parameterized request thus you need to provide a name and optionally description This is also a secure request thus make sure you include the token as a header during this request as below:
The key should be Authorization and the value should be prefixed with Token then [token]: i.e.
Authorization : Token sdvbjsdvnskdvna;scma;scma;cfskvbjrv

Listing all bucketlists:
Ensure the URL points to http://localhost:5000/api/v1/bucketlists/ as a GET request.
This is also a secure request thus make sure you include the token as a header during this request.

Creating a bucketlist item:
Ensure the URL points to http://localhost:5000/api/v1/bucketlists/bucketlist_id/items as a POST request. You have to ensure you have a bucketlist in order to create an item in it. This is also a parameterized request thus you need to provide an item name and optionally description This is also a secure request thus make sure you include the token as a header during this request.

Listing all bucketlists with items:
Ensure the URL points to http://localhost:5000/api/v1/bucketlists/ as a GET request.
This is also a secure request thus make sure you include the token as a header during this request

To test, run the command tox

Check out the License file for more information

• Joseph Muli