- Project Overview
- Features
- Demo
- Built with
- API End Points
- Known Issues
- Installation
- Contributing
- License
SendIT is a courier service that helps users deliver parcels to different destinations. SendIT provides courier quotes based on weight categories. it was built from scratch using Html
, Css
, JavaScript
and Node.js
- Users can create an account and log in,
- A user can create parcel delivery order,
- A user can see history of Parcel delivery orders,
- A user can see the details of a parcel delivery order such as the pickup location, destination, and price.e.t.c
- A user can cancel a parcel delivery order,
- A user can change the destination of a parcel delivery order is yet to be delivered
- The admin can see list of parcel delivery orders,
- The admin change present location of parcel delivery orders,
- The admin can mark orders as pending (in transit) or delivered.
Visit User Dashboard
Visit Admin Dashboard
HTML 5
CSS
JavaScript
Node.js
Express framework
body-parser
morgan
GET /api/v1/users
- Fetches all users in the DatabaseGET /api/v1/parcels
- Fetches all Available Orders in the DatabaseGET /api/v1/parcels/<parcelId>
- Fetches a particular order in the databaseGET /api/v1/users/<usersId>/parcels/
- Fetches the orders of a particualar user in the databasePOST /api/v1/parcels/
- Saves an Order in the databasePOST /api/v1/auth/signup
- Signs up a userPOST /api/v1/auth/login
- User can loginPUT /api/v1/parcels/<parcelId>/presentLocation
- Updates the location of an order in the databasePUT /api/v1/parcels/<parcelId>/status
- Updates the status of an order in the databasePUT /api/v1/parcels/<parcelId>/destination
- Updates the destination of an order in the databasePUT /api/v1/parcels/<parcelId>/cancel
- Cancels an order in the databaseDELETE /api/v1/parcels/<parcelId >
- Deletes an order in the database
Everything works as expected; However:
- the front-end is not complete, i.e. no authentication, few client-side validation and no link for API calls yet.
- Data structures were used to save data instead of a database, hence data gets erased once the server is restarted
- $ git clone
https://github.com/oyedejipeace/SendIT.git
- $ cd SendIT
- $ npm i , to install dependencies
- $ npm start, to start the server
Once the server starts-up, you can query the api at
http://localhost:5000/api/v1
using the end points stated above.
Feel free to 🍴 fork this repository
👯 Clone this repository to your local machine using
https://github.com/oyedejipeace/SendIT.git
Make Contributions
🔃 Create a new pull request using
https://github.com/oyedejipeace/SendIT./compare
- MIT license
- Copyright 2018 © SendIT