Giter VIP home page Giter VIP logo

sendit2's Introduction

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

sendit2's People

Contributors

paulzay avatar dependabot[bot] avatar stickler-ci avatar

Stargazers

Visvaldas avatar Vitalie Melnic avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.