Skip to content

Latest commit

 

History

History
113 lines (105 loc) · 3.79 KB

README.md

File metadata and controls

113 lines (105 loc) · 3.79 KB
Raw

Build Status Coverage Status Maintainability[Front-End React] CircleCI Test Coverage

SendIT

SendIT is a courier service that helps users deliver parcels to different destinations.

How it works

  • Users can:
    • Create a parcel delivery order
    • Get all parcel delivery orders
    • Get a specific parcel delivery order
    • Cancel a parcel delivery order

Technologies

  • Nodejs(ES6)
  • Git
  • NPM
  • Express
  • Babel

Linting Library

  • Eslint

Installation

Ensure you have the technologies installed then you can clone this repository with the URL from the clone or download button on this page using git clone cloned url copied in your local machine. Afterwards, run npm install and run npm run devstart for a quick start. Or you may build first, using npm run build then run npm start . If you only want to access the completed work, you will find the link to the hosted work at the bottom of this readme, you don't have to clone this repository!

Test

Mocha is the testing framework together with chai assertion library

  • You can run test after installation using npm run test

ENDPOINTS

HTTP Request End Point Functionality
GET /api/v1/parcels Fetch all parcel delivery orders
GET /api/v1/parcels/:parcelId Fetch a specific parcel delivery order
GET /api/v1/users/:userId/parcels Fetch all parcel delivery orders by a specific user
PUT /api/v1/parcels/:parcelId/cancel Cancel the specific parcel delivery order
POST /api/v1/parcels Create a parcel delivery order
PUT /api/v1/parcels/:parcelId/status change the status of a parcel order
PUT /api/v1/parcels/:parcelId/presentLocation change the present location of a parcel order
PUT /api/v1/parcels/:parcelId/destination change the destination of a parcel order
POST /api/v1/users/auth/resetpassword sent email to user to reset password
PUT /api/v1/users/auth/resetpassword Change to new user password
POST /api/v1/auth/signup sign up users
POST /api/v1/auth/login login users
GET /api/v1/users/:userId/:parcelId Fetch a user particular parcel order

You can access the app here https://efe-sendit.herokuapp.com You can also access the API documentation at https://efe-sendit.herokuapp.com/api-docs