Skip to content

paulzay/Sendit2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sendit

Build Status Coverage Status Maintainability Codacy Badge

SendIT is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories.

Live demo

live demo link

Getting Started

.Python 3.6

.Postman

.Git

.Nosetest

.Flask

.Flask-restful

Getting Started 🚀

These instructions will get you a copy of the project up and running on your local machine.

How To Use 🔧

From your command line, first clone the project:

  1. Clone the repo or Download zip file from the right hand corner

    https://github.com/paulzay/Sendit2/

  2. cd into the project folder.

First install

  1. python3

    sudo apt-get install python3

  2. install python3 pip

    sudo apt-get install python3-pip

  3. install vitual environment

    pip3 install virtualenv

  4. create the virtual environment

    virtualenv env

  5. Activate the vitualenv in the parent directory of your "env"

    source env/bin/activate

  6. Install requirement

    pip install -r requirements.txt

  7. Run the app

    flask run

  8. Testing

    nosetests

Endpoint Functionality
POST /api/v1/parcels Create a parcel delivery
GET /api/v1/parcels Retrieve all parcel delivery
PUT /api/v1/parcels/int:parcel_id/ Cancel a specific parcel delivery
GET /api/v1/parcels/int:parcel_id Retrieve a specific parcel delivery
GET /api/v1/parcels/str:sender_email Fetch all delivery orders for a user

CONTRIBUTOR

👤 Paul Ogolla

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Andela

📝 License

  • MIT

About

Web api for parcel delivery service.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages