/senditapp

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

Primary LanguageJava

SendIT

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

Stage

Development

GitHub Project Management Board

https://github.com/ucheka22/senditapp.git

API Documentation

https://documenter.getpostman.com/view/11203891/SzfAz77C?version=latest

UI On gh-pages

Not Ready Yet..

Table of Content

Getting Started

Installation

  1. Clone this repository into your local machine:
e.g git clone https://github.com/ucheka22/senditapp.git
  1. Install postman to test all endpoints on port 8080.

BaseURI

Use the baseURI https://mysenditapp.herokuapp.com/api/v1.

API End Points Test Using Postman

HTTP VERBENDPOINTDESCRIPTION
POST auth/signup Create user account
POST /auth/signin Sign a user
POST /parcelsCreate a parcel delivery order
GET/parcelsFetch all parcel delivery orders (Admin only)
GET /parcels/{parcelId}Fetch a specific parcel delivery order
GET /users//parcels Fetch all parcel delivery orders by a specific user
PUT /parcels/{parcelId}/cancelCancel the specific parcel delivery order/td>
PUT /parcels/{parcelId}/destinationChange the location of a specific parcel delivery order/td>
PUT /parcels/{parcelId}/statusChange the status of a specific parcel delivery order/td>
PUT /parcels/{parcelId}/presentLocationChange the present location of a specific parcel delivery order/td>

Features

Main Features

  • The user can create user accounts and can sign in to the app.
  • The user can change the destination of a parcel delivery order.
  • The user can view all parcel delivery orders he/she has created.
  • Admin can view all parcel delivery orders in the application.
  • Admin can change the status of a parcel delivery order.
  • Admin can change the present location of a parcel delivery order

Additional Features

  • The application should display a Google Map with Markers showing the pickup location and the destination.
  • The application should display a Google Map with a line connecting both Markers (pickup location and the destination).
  • The application should display a Google Map with computed travel distance and journey duration between the pickup location and the destination.
  • The user gets real-time email notification when Admin changes the status or the present location of a parcel.

Built With

  • SERVER : Java and Spring Boot

  • STYLING : Material UI.

  • FRONT-END : React

  • DATABASE : PostgreSQL

  • Testing : Unit Testing : TestNG and Rest Assured;

Author

License

This project is licensed under the MIT license - see the LICENSE.md file for details.