Express TypeScript Boilerplate

A boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, Mongoose and TypeScript. By running a single command, you will get a production-ready Node.js app installed and fully configured on your machine.

🚀 Quick Start

To create a project, simply run:

$ npx @dk122809_org/nodejs_ts_starter "project name"

$ cd "project name"

$ yarn run start

Start your typescript-express-starter app in development mode at `http://localhost:8081/`

Template Type

Name	Desc
Default	Express Default
Routing Controllers	Create structured, declarative and beautifully organized controllers
Mongoose	MongoDB Object Modeling(ODM) designed to work in an asynchronous environment

🛎 Available Commands for the Server

Run the Server in production mode : yarn run start
Run the Server in development mode : yarn run dev
Generate documention : yarn run docs
Check for linting errors : yarn run lint
Fix for linting : yarn run lint:fix

💎 The Package Features

Application
DevOps
Database

🗂 Code Structure (default)

        ├── /docs
        ├── /src
        │   ├── /config
        │   │   ├── mongo.ts
        │   │   ├── server.ts
        │   │   └── vars.ts
        │   │
        │   ├── /controllers
        │   │   └── auth.ts
        │   │
        │   ├── /middlewares
        │   │   ├── auth.ts
        │   │   └── requestValidation.ts
        │   │
        │   ├── /models
        │   │   └── user.ts
        │   │
        │   ├── /routes/v1
        │   │   └── auth.ts
        │   │
        │   ├── /utils
        │   │   ├── apiResponse.ts
        │   │   └── responseMessage.ts
        │   │
        │   ├── /validations
        │   │   └── auth.ts
        │   │
        │   └── index.ts
        │
        ├── /upload
        ├── .dockerignore
        ├── .env.development
        ├── .env.production
        ├── .eslintrc
        ├── .gitignore
        ├── Dockerfile
        ├── package.json
        └── tsconfig.json