Skip to content

A NodeJS TypeScript barebones starter kit with logging and testing setup

Notifications You must be signed in to change notification settings

tpina/node-ts-barebones

Repository files navigation

Node-ts-barebones

An Boilerplate skeleton kit to start builing your Node.js and Typescript app.

What's in the box??? 📦

I have also added:

  • a custom logger
  • pre-commit hook to run lint, prettier and tests

Usage

  1. Clone
  2. Run npm install && npm run start:dev

Scripts

  • build - Builds the app and outputs it to the dist folder.
  • format - Runs Prettier code formatter.
  • start - Starts the application.
  • start:dev - Starts the application in dev mode with hot-reloading.
  • start:debug - Starts the application in dev mode with debug capabilities.
  • prestart:prod - Cleans the dist folder and compiles the TS code.
  • start:prod - Runs the prod build from the dist folder.
  • lint - Runs the linter.
  • tests - Runs unit tests.
  • tests:watch - Runs unit tests in watch mode.
  • tests:cov - Runs unit tests and generates coverage report.
  • tests:debug - Useful to debug tests.

Maintainer

Tiago Pina Original Author - Follow on: Twitter @taspina & GitHub @tpina

About

A NodeJS TypeScript barebones starter kit with logging and testing setup

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published