https://github.com/dominique-mueller/node-typescript-nestjs-starter

Starter for NestJS projects using TypeScript
https://github.com/dominique-mueller/node-typescript-nestjs-starter

boilerplate ncc nestjs nodejs seed starter template typescript

Last synced: 21 days ago
JSON representation

Starter for NestJS projects using TypeScript

• Host: GitHub
• URL: https://github.com/dominique-mueller/node-typescript-nestjs-starter
• Owner: dominique-mueller
• License: mit
• Created: 2019-07-20T15:00:58.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T23:42:55.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T17:10:44.010Z (3 months ago)
• Topics: boilerplate, ncc, nestjs, nodejs, seed, starter, template, typescript
• Language: TypeScript
• Homepage:
• Size: 1.25 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# node-typescript-nestjs-starter

**Starter for [NestJS](https://nestjs.com/) projects using [TypeScript](https://www.typescriptlang.org/)**







## What it does

This is a starter project for NodeJS backend applications, based on the **[NestJS](https://nestjs.com/)** framework, written in

**[TypeScript](https://www.typescriptlang.org/)**. 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](https://github.com/zeit/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](https://github.com/nestjs/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                         | :heavy_check_mark: |

| `npm run start:build` | Runs the production build                          | :heavy_check_mark: |

| `npm run test`        | Executes all unit tests                            | :heavy_check_mark: |

| `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.