Express Pilot

Boilerplate Project for building RESTful APIs and microservices using Node.js, Express, Typescript, and MongoDB.

Key Highlights

• Typescript integration
• ES2017 latest features like Async/Await
• Cors Enabled
• Uses helmet to set some HTTP headers for security
• Load environment variables from .env files with dotenv
• JWT based Authentication and Authorization for the APIs using passport.js
• Predefined Register and Login api
• Forgot and reset password flow
• Example of predefined routes with jwt verification
• Logging mechanism using winston logger

Requirements

• Node
• Mongo or Docker

Getting Started

Clone the repo

git clone https://github.com/bksh05/Express-Pilot.git

cd Express-Pilot/

Install dependencies

npm install

Set environment variables

cp .env-example .env

Populate the .env file with your own configuration

The configuration depends upon your mongo installation. If you don't have mongo installed you can check mongo docs or check steps here to run mongodb on docker.

Run it locally

npm start