The Paragon Minimalistic Node.js + TypeScript boilerplate. Originally forked from this repo.
What's included:
- TypeScript 3.6
- TSLint with Microsoft Rules
- Jest unit testing and code coverage,
- Type definitions for Node.js and Jest,
- Prettier to enforce a consistent code style,
- NPM scripts for common operations,
- .editorconfig for consistent file format.
This project is intended to be used with the latest Active LTS release of Node.js. To start, just clone the repository with following commands:
git clone https://github.com/useparagon/node-typescript-boilerplate
cd node-typescript-boilerplate
npm install
Copy the example.env
file to a file called .env
and add the configuration needed for the required services.
compile
- compile a Paragon serverclean
- remove coverage data, Jest cache and transpiled files,build
- transpile TypeScript to ES6,build:watch
- interactive watch mode to automatically transpile source files,lint
- lint source files and tests,test
- run tests,test:watch
- interactive watch mode to automatically re-run tests