kvvignesh / Node-TypeScript-Express-MongoDB

Boilerplate for Node-TypeScript-Express-MongoDB

Node-TypeScript-Express-MongoDB Boilerplate

This repo can be used as a starting point for backend development with Nodejs, Express, TypeScript and MongoDB.

A few things to note in the project:

• TypeScript - It uses TypeScript.
• JWT - It uses JWT Token for Authentication.
• Mongo Connection Helper - A helper class to connect to MongoDB reliably.
• Joi - For declarative payload validation
• Middleware for easier async/await - Catches errors from routes and throws them to express error handler to prevent app crash due to uncaught errors.
• .env file for configuration - Change server config like app port, mongo url etc
• Winston Logger - Uses winston as the logger for the application.
• ESLINT - ESLINT is configured for linting.
• Jest - Using Jest for running test cases
• Swagger - Open API Specification

Installation

Manual Method

1. Clone this repo

$ git clone https://github.com/kvvignesh/Node-TypeScript-Express-MongoDB.git your-app-name
$ cd your-app-name

2. Install dependencies

$ npm i

Development

Start dev server

$ npm run dev

Running the above commands results in

• 🌏API Server running at http://localhost:3000
• 🛢️MongoDB running at mongodb://localhost:27017

Environment

To edit environment variables, create a file with name .env and copy the contents from .env.sample to start with.

Var Name	Type	Default	Description
NODE_ENV	string	development	API runtime environment. eg: production
PORT	number	3000	Port to run the API server on
MONGO_URL	string	mongodb://localhost:27017/library	URL for MongoDB
SECRET	string	iAmSuperBoy	JWT Token's Secret Key

Logging

The application uses winston as the default logger. The configuration file is at src/logger.ts.

• All logs are saved in ./logs directory.
• Console messages are prettified
• Each line in error log file is a stringified JSON.

License

Copyright (c) kvvignesh. All rights reserved. Licensed under the MIT License.