Node TypeScript Boilerplate Mongoose

The main purpose of this repository is to show a good end-to-end project setup and workflow for writing a Mongoose Node.js Express code in TypeScript complete with middleware, models, routes, and types.

This example comes with a complete REST API to handle Authentication and CRUD features on Users and their corresponding Profile.

Tech Stack

Server: Node, Express, typescript, ts-node

DataBase: mongoose

Run Locally

Clone the project

  git clone https://github.com/chiragmehta900/node-typescript-boilerplate-mongoose

Go to the project directory

  cd node-typescript-boilerplate-mongoose

Install dependencies

  npm install

Start the tsc

  npm run watch

Start the server

  npm run dev

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

NODE_ENV="production", NODE_ENV="local", MONGO_DB_USER, MONGO_DB_PASSWORD. JWT_SECRETS, SMTP_HOST, SMTP_PORT, SMTP_USERNAME, SMTP_PASSWORD, SMTP_SENDER,

Project Structure

The most obvious difference in a TypeScript + Node project is the folder structure. In a TypeScript project, it's best to have separate source and distributable files. TypeScript (.ts) files live in your src folder and after compilation are output as JavaScript (.js) in the dist folder.

The full folder structure of this app is explained below:

Note! Make sure you have already built the app using npm run start

Configuring TypeScript compilation

TypeScript uses the file tsconfig.json to adjust project compile options. Let's dissect this project's tsconfig.json, starting with the compilerOptions which details how your project is compiled.

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "lib": [
      "es2016",
      "dom"
    ],
    "allowJs": true,
    "checkJs": true,
    "declaration": true,
    "sourceMap": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "removeComments": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "pretty": true,
    "experimentalDecorators": true,
    "typeRoots": [
      "node_modules/@types"
    ]
  },
  "include": [
    "src/**/*.ts"
  ],
  "exclude": [
    "node_modules"
  ]
}

Documentation

Documentation

API Reference

Create user

  POST user/sign-up

login user

  POST auth/login

Get all users

  GET user/fetch

A postman collection has been added for better understanding.

Badges

Add badges from somewhere like: shields.io

Author

• @chiragmehta900

Support

For support, email [email protected] or join our Slack channel.