/send-itv2

Primary LanguagePython

SENDIT v2

Build Status Coverage Status Python 3.6

This is an application that allows user to send parcel online

How to install

Requirements

  1. Check the requirements.txt on the root folder see all the required modules
  2. Install the requirements using pip install -r requirements.txt

Installation

  1. Copy this repo
  2. Open your terminal or CMD
  3. cd to the root of this directory
  4. If you have a virtual enviroment activate
  5. If you dont have one istall the virtual enviroment
  6. use the command export FLASK_ENV=production to set your enviroment
  7. use the command flask run to start your application 8 if on localhost the app will run on 127.0.0.1:5000
  8. @Client 😃 The app is now up and running :shipit:

How to test using pytest

  1. cd to the root of the project
  2. activate the virtual enviroment
  3. use pytest to test
  4. To check the coverage use pytest --cov=app/ to see the coverage of the app

How to test using postman

  1. Open the link below (Postman)
  2. On postman you will see the required fields
  3. Also you will see the endpoints
  4. Presss send for each endpoint amd wait for response

Endpoints

Run in Postman

Documentation

https://documenter.getpostman.com/view/4007386/RzfZNsXQ

Heroku link

https://senditv2.herokuapp.com