Code Monkey home page Code Monkey logo

node-typescript-express-mongodb's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.