/sendit-nestjs-api

This is a project meant to demonstrate application of nestjs framework for API development

Primary LanguageTypeScript

SendIT

Build Status Coverage Status Maintainability

Description

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

Original Repo

This project is a demonstration of how to use nestjs. Checkout the original repo here

Features

  • 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

Getting Started

Installation

API Endpoint Routes

NOTE: All requests are prefixed with api/v1

HTTP VERBENDPOINTTASK
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

Author

Samuel Osuh