jsynowiecjsynowiec
2939

Node Typescript Boilerplate

screenshot of Node Typescript Boilerplate
express

Minimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Vitest and type definitions included.

Github

Overview

The "node-typescript-boilerplate" is a comprehensive template that is ready to use for most Node.js projects. It provides all the basic tools and configurations needed for a smooth development experience. The template is available under the APLv2 license.

Features

  • Developer Ready: Works out of the box for most Node.js projects.
  • Instant Value: Includes all basic tools and configurations such as TypeScript, ESM, ESLint, Jest, Prettier, and more.
  • Free as in Speech: Available under the APLv2 license.

Use as a repository template

  1. Click on the "Use template" link or the green button to start using the template.
  2. Add your code in the src directory and write unit tests in the __tests__ directory.

Clone repository

To clone the repository, use the following commands:

git clone <repository-url>

Available Scripts

  • clean: Removes coverage data, Jest cache, and transpiled files.
  • prebuild: Lints source files and tests before building.
  • build: Transpiles TypeScript to ES6.
  • build:watch: Interactive watch mode to automatically transpile source files.
  • lint: Lints source files and tests.
  • prettier: Reformats files.
  • test: Runs tests.
  • test:watch: Interactive watch mode to automatically re-run tests.

Summary

The "node-typescript-boilerplate" is a comprehensive template for Node.js projects. It includes all the necessary tools and configurations to start developing right away. With TypeScript, ESM, ESLint, Jest, and Prettier, developers can ensure code quality, maintainability, and an efficient development process. The template can be used as a repository template or cloned directly from the repository. It is licensed under the APLv2.

express
Express

Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.