Skip to content

dominique-mueller/node-typescript-nestjs-starter

Repository files navigation

node-typescript-nestjs-starter

Starter for NestJS projects using TypeScript



What it does

This is a starter project for NodeJS backend applications, based on the NestJS framework, written in TypeScript. The setup comes with tasks for building and testing the application, further aspects like linting and / or formatting are not defined but can easily be added on top.

Here is where things get interesting: This starter project uses ncc as its build tool. This enables us to deliver the production build of the application as a single minified JavaScrip bundle. No copying of node_modules is necessary, no npm install on servers required!

Also see the official Nest Framework TypeScript Starter.



Commands

The following commands are available:

Command Description CI
npm start Creates a development build, running in watch mode
npm run build Creates a production build ✔️
npm run start:build Runs the production build ✔️
npm run test Executes all unit tests ✔️
npm run test:watch Executes all unit tests, running in watch mode

The build command will output the result into the build folder, the application itself will be put at build/index.js. The test coverage will be put into the coverage folder.