An open API service indexing awesome lists of open source software.

https://github.com/shubhrajps/shipit_backend

A Nest.js app for a courier aggregation and booking platform, offering real-time package tracking and efficient order management for vendors.
https://github.com/shubhrajps/shipit_backend

aws-ec2 codepipeline nestjs postgresql typeorm

Last synced: 2 months ago
JSON representation

A Nest.js app for a courier aggregation and booking platform, offering real-time package tracking and efficient order management for vendors.

Awesome Lists containing this project

README

          

# Shipit

The advent of on-demand applications has redefined customer convenience. The Courier
delivery industry has transformed due to the repercussions of on-demand services. And to do
that you would require an advanced courier & parcel delivery application that consists of all the
cutting-edge features.

# Table of Contents
1. [Demo](https://github.com/kkk0908/shipit-api-server-final/edit/master/README.md#demo)
2. [Installation](https://github.com/kkk0908/shipit-api-server-final/edit/master/README.md#installation)
3. [Technology Stack](https://github.com/kkk0908/shipit-api-server-final/edit/master/README.md#technology-stack)
4. [Authors](https://github.com/kkk0908/shipit-api-server-final/edit/master/README.md#authors)
5. [License](https://github.com/kkk0908/shipit-api-server-final/edit/master/README.md#license)

# Demo
Live Demo

### Please Note:
1. We recommend using this app in Google Chrome
2. Use the app on Laptop/desktop only as of now.

### Test Credentials:
#### * For User
1. Phone Number: 9999999999
2. OTP: 111111
#### * for Vendor
1. Email:"contact2satish.patna@gmail.com"
2. password: 123456

# Installation
### 1. Clone the repo
```git clonehttps://github.com/pesto-students/caretaker-fe-n10-eta.git careTracker-fe```
### 2. Set environment variables
```
# MAIL CONFIGURATION

MAIL_SERVICE =
EMAIL_USER =
EMAIL_PASS =
EMAIL_HOST =
EMAIL_PORT =
SECURE =
MAIL_USE_TLS =
MAIL_USE_SSL =
```

### Install NPM packages

```cd shipit-api-server-final && npm install```

### Run
```npm start```

Open http://localhost:3000 to view it in the browser

### Run Test cases

```npm test```

### Technology Stack
We tried to use a completely modern tech stack while testing out some new technologies that we had never used before. This resulted in a fast, performant, and easily-extensible web app that should be fairly future-proof for the coming next several years.
* We used:
1. Frontend React: Apollo Client, RxJS, Framer Motion, Tailwind css, Recharts
2. Backend NestJS, TypeORM,
3. Auth JWT token
4.Database: PostgreSQL
5.Deployments: AWS EC2, AWS Codepipeline
6. CI/CD: GitHub,

### Authors
1. [Shubhraj Prasad Singh](https://github.com/Shubhraaaj)
2. [Satish Kumar](https://github.com/kkk0908)

### License
MIT