Skip to content
/ nestjs-template Public template

This template helps me start new applications using NestJS, a progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular

Notifications You must be signed in to change notification settings

joaofaveri/nestjs-template

Repository files navigation

Nest Logo

Nest is a progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular. This template helps me start new applications 🚀.


Description and Features

Nest framework TypeScript starter repository. It includes the following:

  • ESLint and Prettier configured and ready to go!
  • Husky: used to add pre-commit and commit-msg Git hooks
  • Commitlint: a CLI used to lint commit messages
  • Commitizen: helps you write commit messages
  • Lint-Staged: to do basic lint checks and prettier formatting of your staged files
  • Helmet: protect your app from some well-known web vulnerabilities by setting HTTP headers appropriately
  • CORS: mechanism that allows resources to be requested from another domain

Creating a repository from a template

You can generate a new repository with the same directory structure and files as this repository. Creating a repository from a template is similar to forking a repository, , but there are important differences:

  • A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit.
  • Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph.
  • A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly.

Creating a repository from a template:

  1. On GitHub.com, navigate to the main page of the repository.
  2. Above the file list, click Use this template.
  3. Use the Owner drop-down menu, and select the account you want to own the repository.
  4. Type a name for your repository, and an optional description.
  5. Choose a repository visibility.
  6. Optionally, to include the directory structure and files from all branches in the template, and not just the default branch, select Include all branches.
  7. Optionally, if the personal account or organization in which you're creating uses any GitHub Apps from GitHub Marketplace, select any apps you'd like to use in the repository.
  8. Click Create repository from template.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

Distributed under the MIT License. See LICENSE.txt for more information.

About

This template helps me start new applications using NestJS, a progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published