Send-IT API Endpoints

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

I have already upload the UI template for this project on github and if you want to have a look follow this link

Here is a list of all API Endpoints that you will find:

• GET/parcels Fetch all parcel delivery orders
• GET/parcels/:parcelid Fetch a specific parcel delivery order
• GET/users/:userid/parcels Fetch all parcel delivery order by a specific user
• PUT/parcels/:parcelid/cancel Cancel a specific parcel delivery order
• POST/parcels Create a parcel delivery order
• GET/users Fetch all users
• GET/users/:userid Fetch a specific user by id
• POST/users Create a user
• PUT/users/login Login a user account
• PUT/users/logout Logout a user account
• PUT/users/:userid/update-profile Update the user profile

Technology Tools used

• Server-side Framework: Node/Express JS
• Linting Library: ESlint
• Style Guide: Airbnb
• Testing Framework: Mocha with Chai

Additional Tools

• JavaScript Es6 with Babel transpiler
• TravisCI for Continous Integration
• Istanbul and nyc for test coverage
• CodeClimate and Coveralls for badges
• Heroku for Deployment

The url of the app on heroku is this one sendparcel.herokuapp.com.

This is the list of all routes as on the heroku deployment:

• Fetch all parcel delivery orders at sendparcel.herokuapp.com/api/v1/parcels
• Fetch a specific parcel parcel delivery order at sendparcel.herokuapp.com/api/v1/parcels/:parcelid
• Fetch all parcel delivery order by a specific user sendparcel.herokuapp.com/api/v1/users/:userid/parcels
• Cancel the specific parcel delivery order sendparcel.herokuapp.com/api/v1/arcels/:parcelid/cancel
• Create a parcel delivery order sendparcel.herokuapp.com/api/v1/parcels

For a full list of all api endpoints API Endpoints

For a better test you will need to use POSTMAN

Setup Instruction

• Install git
• Install Node js

For getting the files into your local machine open git bash and do git clone with repository url

$ git clone https://github.com/Nziranziza/Send-IT.git

Navigate to the folder containing all code files by typing cd folder_name

$ cd Send-IT

Install dependincies as they appear in package.json file by

$ npm install

To start the server do

$ npm start

To run the test do

$ npm test

For eslint test do eslint file_name. For example this will test app.js

$ eslint app.js