Flask API
| URL Endpoint | HTTP Methods | Summary |
|---|---|---|
/auth/register/ |
POST |
Register a new user |
/auth/login/ |
POST |
Login and retrieve token |
/bucketlists/ |
POST |
Create a new Bucketlist |
/bucketlists/ |
GET |
Retrieve all bucketlists for user |
/bucketlists/?limit=2 |
GET |
Retrieve one bucketlist per page |
/bucketlists/?q=bl |
GET |
Match bucketlist by name |
/bucketlists/<id>/ |
GET |
Retrieve bucket list details |
/bucketlists/<id>/ |
PUT |
Update bucket list details |
/bucketlists/<id>/ |
DELETE |
Delete a bucket list |
/bucketlists/<id>/items/ |
POST |
Create items in a bucket list |
/bucketlists/<id>/items/<item_id>/ |
DELETE |
Delete a item in a bucket list |
/bucketlists/<id>/items/<item_id>/ |
PUT |
update a bucket list item details |
Flask API has been developed and tested on Python 3. The recommended version is Python 3.5.2. Using your package manager or binaries from the official Python language website, install Python 3 first.
Follow the following steps to have the system running:
- ####Clone this repo:
- Using HTTPS:
git clone https://github.com/andela-andrewmakenzi/flaskbucketlist.git
- Using SSH:
git clone [email protected]:andela-andrewmakenzi/flaskbucketlist.git
- Navigate to the application directory:
cd flaskbucketlist
- Create a virtual environment to install the application in. You could install virtualenv and virtualenvwrapper. Within your virtual environment, install the application package dependencies with:
pip install -r requirements.txt
- Run the application with:
python run.py