SendIT is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories.
- HyperText Mark-up Language (HTML)
- Cascade Style Sheet (CSS)
- Javascript
- Nodejs (Express framework)
- Mocha (Test Framework)
- Chai (Assertion Library)
SendIT can be found on pivotal tracker with the link below. (https://www.pivotaltracker.com/n/projects/2218905)
The API is hosted at (https://johnnysam-sendit.herokuapp.com/api/v1)
The ui templates are currently hosted on gh-pages (https://jsamchineme.github.io/send-it/UI/)
The API documentation can be found through this url (https://johnnysam-sendit.herokuapp.com/docs)
- Fetch all parcel delivery orders
- Create a parcel delivery order
- Fetch a specific parcel delivery order
- Fetch all parcel delivery orders by a specific user
- Cancel the specific parcel delivery order
- Change the status of a parcel delivery order
- Change the destination of a parcel delivery order
- Change the present location of a parcel delivery order
- User Signup
- User Login
- run npm install
- You can test routes with POSTMAN
- Here is a collection of requests to test available end points on POSTMAN https://www.pivotaltracker.com/file_attachments/93440857/download?inline=true
- The environment can also be loaded with the collection https://www.pivotaltracker.com/file_attachments/93331262/download?inline=true
- After loading the
collectionand theenvironment, the POSTMANCollection Runnercan be used to run the requests automatically and generate test report - run
npm run startto start the server - You can also run
npm run start:devto start the server in development mode - run
npm run testto test the api
| HTTP VERB | ENDPOINT | TASK |
|---|---|---|
| GET | parcels?token={adminToken} | Fetch all parcel delivery orders |
| POST | parcels?token={userToken} | Create a parcel delivery order |
| GET | parcels/:id?token={ownerAuthToken} | Fetch a specific parcel delivery order |
| GET | users/:id/parcels?{ownerAuthToken} | Fetch all parcel delivery orders by a specific user |
| PUT | parcels/:id/cancel?token={ownerAuthToken} | Cancel the specific parcel delivery order |
| PUT | parcels/:id/status?{adminAuthToken} | Change the status of a parcel delivery order |
| PUT | parcels/:id/destination?token={ownerAuthToken} | Change the destination of a parcel delivery order |
| PUT | parcels/:id/presentLocation?token={ownerAuthToken} | Change the present location of a parcel delivery order |
| POST | auth/signup | User Signup |
| POST | auth/login | User Login |
| GET | users/:id | Get User profile |
| POST | auth/reset | Request Password Reset |
| PUT | auth/reset | Change User password |
Samuel Osuh