👩🏻💻 Developer Ready: A comprehensive template. Works out of the box for most Node.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
- Reproducible environments thanks to Volta
- Example configuration for GitHub Actions
This project is intended to be used with the latest Active LTS release of Node.js.
Use as a repository template
To start, just click the Use template link (or the green button). Start adding your code in the
src and unit tests in the
To clone the repository, use the following commands:
git clone https://github.com/jsynowiec/node-typescript-boilerplate cd node-typescript-boilerplate npm install
Download latest release
Download and unzip the current main branch or one of the tags:
wget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip unzip node-typescript-boilerplate.zip && rm node-typescript-boilerplate.zip
clean- remove coverage data, Jest cache and transpiled files,
prebuild- lint source files and tests before building,
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
Why include Volta
Volta’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's used by engineers at LinkedIn to standardize tools and have reproducible development environments.
I recommend to install Volta and use it to manage your project's toolchain.
Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.
Backers & Sponsors
Support this project by becoming a sponsor.
Licensed under the APLv2. See the LICENSE file for details.