express-typescript-boilerplate's Introduction

node-typescript-boilerplate

👩🏻‍💻 Developer Ready: A comprehensive template for Typescript Express.Js projects.

🏃🏽 Instant Value: All basic tools included and configured:

TypeScript 4.3
ESLint with some initial rules recommendation
Jest for fast unit testing and code coverage
Type definitions for Node.js and Jest
Prettier to enforce consistent code style
NPM scripts for common operations
Simple example of TypeScript code and unit test
.editorconfig for consistent file format

Getting Started

This project is intended to be used with the latest Active LTS release of Node.js.

Using NPM

This package is used to generate Typescript project, so I recommend to install it globally. Then run command to create new project whenever we want

npm install -g typescript-maker

# Generate new project

typescript-maker init my-project

Available options

- ioc : setup IOC container using [inversify](https://www.npmjs.com/package/inversify) (default: normal express)
- p --pipeline <pipeline tool>: setup pipeline template (default: CircleCI)

Create pipeline template

# currently it just supports 'circleci' or 'github'

typescript-maker create-pipeline circleci

Use as a repository template

To start, just click the Use template link (or the green button). Then, select which pipeline you gonna use by moving that one out of pipeline folder and removing pipeline folder. Start adding your code in the src and unit tests in the __tests__ directories.

Clone repository

To clone the repository, use the following commands:

git clone https://github.com/Maithanhdanh/express-typescript-biolerplate.git
cd express-typescript-biolerplate
npm install

Note

A new decorator logGroup is add to version 1.2.3.
It will add called method to logger prefix by modifying the definition of the class and method