Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 3.95 KB

README.md

File metadata and controls

111 lines (80 loc) · 3.95 KB
Raw

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

Installation

$ yarn install

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Commits

All commit messages should conform to the conventional commit format and should use following syntax: type(scope): subject. While the type is mandatory, the scope is optional. Examples:

docs: add README.md

fix(Header): fix padding issue

feat: create Home view

Main types are fix and feat, however it is possible to also use:

  • chore
  • docs
  • style
  • refactor
  • perf
  • test

Pull Request

Checkout new branch from develop

Branches must begin with feature/example-task-title (for example, feature/add-nav-header).

And for bugfix task should be like bugfix/example-task-title

For most PRs, remember to always:

Merge to develop, never to main, add the label "Ready for review" (use "Work in progress" until you're ready to have it reviewed), make sure every comment was resolved and every reviewer approved the PR before merging, merge using "squash and merge".

For deployment PRs, remember to:

merge to main title the PR "Merge to Main" add the label "Deployment" merge using normal merge.

License

Nest is MIT licensed.