Project title here

This project was bootstrapped with Framework name here.

About this project with description

• Point 1
• Point 2
• Point 3 and so on

Requirements

• Node Js v14
• MongoDb v4

SDK's Used in this project

• Paypal
• MailChimp
• Mongoose

Contact Person for AWS access

• Name: Person name
• Email: Person email

Installation Instructions

Globally install xyz framework

npm install -g xyz

• This installation is required due to xyz reason

Setup Instructions

Clone the repo and install the dependencies.

npm install

Create .env file in the project root

Add these credentials in .env file
DBUri=<specify value here>

Running on local

To start the server, run the following

npm start

Deployment command

npm deploy

Documentation

See the collection for documentation:

Architecture Diagram

Flow Diagram

Database Design

• This is relational database design
• Models are defined in src/models folder

Wiki of one complex feature

• Read the detailed explanation of xyz feature
• Wiki link: https://github.com/ahsan-javaid/documentation/wiki