sendit-api

Bootcamp 14

Badges

Features

• Create a parcel delivery order
• Get all parcel delivery orders
• Get a specific parcel delivery order
• Cancel a parcel delivery order
• Get parcels by user id

API Endpoints

REQUEST	ROUTE	FUNCTIONALITY
GET	/api/v1/parcel	Fetch all parcel delivery orders
GET	api/v1/parcel/<parcel_id>	Fetch a specific parcel delivery order
GET	api/v1/users	Fetches all users
GET	api/v1/users/<user_id>	parcel
POST	/api/auth/signup	User signup
POST	/api/auth/login	Login
PUT	/api/v1/parcel/<parcel_id> /cancel	Cancel parcel

Getting started with the app

Modules and tools used to build the endpoints

• Python 3.6

• Flask

Installation

Create a new directory and initialize git in it. Clone this repository by running

$ git clone URL   which in this case is https://github.com/masete/sendit-api.git

Create a virtual environment. For example, with virtualenv, create a virtual environment named venv using

$ virtualenv venv

Activate the virtual environment

$ cd venv/scripts/activate

Install the dependencies in the requirements.txt file using pip

$ pip install -r requirements.txt

Populate the requirements.txt using

$ pip freeze > requirements.txt

Start the application by running

$ python run.py

 
The APP is hosted on heroku, checkout this Link: https://sendit-ma.herokuapp.com/

## Author
Masete Nicholas @masete


Hope you had a nice ride