SendIT
Description
SendIT is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories.
Installation
- Clone this repository:
https://github.com/Joyce-O/SendIT.git
- cd into the repository:
cd SendIT
- Open the repository in terminal and Install dependencies by running:
npm install
-
Run "npm start" to start the app
-
Use Postman to test all endpoints
-
Run "npm test" to test all endpoints
Technologies
ES6: See here for details.
NodeJS: An asynchronous event driven JavaScript runtime, designed to build scalable network applications. Visit here for details.
Airbnb JavaScript style guide was adopted as a coding convention, see here for details.
ExressJS: This is the web application framework for Node.js Visit here for details.
API Endpoints
| HTTP VERB | API ENDPOINT | FUNCTION |
|---|---|---|
| GET | api/v1/parcels | fetch all parcel delivery orders |
| GET | api/v1/parcels/:parcelId | fetch a specific parcel delivery order |
| PUT | api/v1/parcels/:parcelId/cancel | cancel the specific parcel delivery order |
| POST | api/v1/parcels | Create a parcel delivery order |
| POST | api/v1/users | Sign up a user |
| GET | api/v1/users/:userId | Get a specific user |
| GET | api/v1/users/:userId/parcels | fetch all parcel delivery orders by a specific user |