Node-Typescript-Boilerplate

Skeleton for Node.js applications written in TypeScript

Purpose

Our main purpose with this Skeleton is to start server application with node js and typescript.

Try it!! I am happy to hear your feedback or any kind of new features.

Common Features

Quick start
Integrated eslint, prettier and husky
Common Error Handler
Common Response Handler
Simple and Standard scaffolding
Followed SOLID Principles
Based on Typescript Syntax
Simple Enviroment Configuration
Global Enviroment Object
Request/Response Encryption & Decryption Implementation
Easily Add new feature
Integrated winston Logger
Production Ready Skeleton
Follwed Production Ready Best Practices: Security
Added only used npm modules
Unit & Integration Test Cases

Core NPM Module

Start the application

  flowchart TD;
      A[Start the application]--NODE_ENV=local-->B[Development Mode];
      A--NODE_ENV=test-->C[Test Mode];
      A--NODE_ENV=production-->D[Production Mode];

      B-->E[Install the dependencies `npm install`];
      C-->F[Install the dependencies `npm install`];
      D-->G[Install the dependencies `npm install`];

      E--creat local environment `.env.local`-->H[Start the application `npm start`];
      F--creat test environment `.env.test`-->I[Create the build `npm run build`];
      G--creat prod environment `.env.prod`-->J[Create the build `npm run build`];

      I-->K[Start the application `npm start:test`];
      J-->L[Start the application `start:production`];

Start The application in Development Mode

Clone the Application git clone https://github.com/santoshshinde2012/node-boilerplate.git
Install the dependencies npm install
Start the application npm start

Start The application in Production Mode

Install the dependencies npm install
Create the build npm run build
Start the application npm run start:production
Before starting make sure to creat prod environment .env.prod file

Project Structure

Name	Description
wiki/	You can add project documentation and insructions file here
src/	Source files
src/abstractions	Abstarct classes and Interfaces
src/components	REST API Components & Controllers
src/environments	Application Environments Handling utility
src/lib	Reusable utilises and library source code like a logger
src/middleware/	Express Middlewares like error handler feature
build/	Compiled source files will be placed here
tests/	Test cases will be placed here
tests/helpers/	Helpers for test cases will be placed here
tests/unit-tests/	Unit Test cases will be placed here
tests/integration-tests/	API routes (Integration) Test cases will be placed here

Workflow

Encryption

Set the APPLY_ENCRYPTION environment variable to true to enable encryption.

Global Environment Object

You can directly access the environment attributes in any component/file using global environment object. For more details please check file src/global.ts.

Example

To access the applyEncryption attribute from Envionment class to Response Handler, write environment.applyEncryption;

Default System Health Status API

${host}/api/status/system - Return the system information in response
${host}/api/status/time - Return the current time in response
${host}/api/status/usage - Return the process and system memory usage in response
${host}/api/status/process - Return the process details in response
${host}/api/status/error - Return the error generated object in response

Refrences

Notes

1. Why is my git pre-commit hook not executable by default?

Because files are not executable by default; they must be set to be executable.

chmod ug+x .husky/*
chmod ug+x .git/hooks/*

2. Production Best Practices: Security

Don’t use deprecated or vulnerable versions of Express
Use TLS
Use Helmet
Use cookies securely
Prevent brute-force attacks against authorization
Ensure your dependencies are secure
Avoid other known vulnerabilities
Additional considerations

Please connect with me on Twitter @shindesan2012 & https://blog.santoshshinde.com

tempurai/square