Laborit: Nest JS App Structure

Master (Production):

Develop (Staging):

Test Coverage

Master (Production):

Develop (Staging):

Sobre

Biblioteca com estrutura base das aplicações NestJS desenvolvidas pela Laborit.

Requirements

• Node 12

Stack

• Nest.js 7.4.1

Setup do ambiente de desenvolvimento

O jeito mais simples e tranquilo de instalar o node atualmente é atraves do nvm

$ git clone [email protected]:flaborit/nestjs-app-structure.git
$ cd nestjs-app-structure/
$ nvm install
$ nvm use
$ node -v  # v12.17.0
$ npm install

Suíte de Testes

Utilizamos as bibliotecas padrões do Nest para testar a aplicação, isso inclui: Jest, você pode obter mais informações no Guia: "Testing NestJS Applications"

# Unit Tests
$ npm run test

# unit test + test coverage
$ npm run test:coverage

Continuous Integration Tests

# Unit + integration (e2e) tests + cove coverage (NODE_ENV=test)
$ npm run test:ci

# Unit tests + coverage (NODE_ENV=test)
$ npm run test:ci:coverage

Code Coverage

Utilizamos o Instanbul para gerar instrumentar e gerar o relatório de Code Coverage quando os testes são executados.

Quando o comando npm run test:coverage é executado os metadados + relatório HTML de coverage são criados na pasta coverage/, para visualizar basta executar:

$ xdg-open coverage/index.html # Linux
$ open coverage/index.html # Mac

F.A.Q & Dicas

Code Coverage Report

• https://flaborit.gitlab.io/nestjs-app-structure/569358230bfc9ad56a58a2ee/coverage/ (Unit Test Coverage)

Demo API

• https://nestjs-livestreaming-test-stg.herokuapp.com/api-docs/ (Staging)

• https://nestjs-livestreaming-test.herokuapp.com/api-docs/ (Production)

Referências & links úteis

• https://gitlab.com/flaborit/nestjs-app-structure

• https://docs.nestjs.com/

• https://docs.nestjs.com/fundamentals/testing

• https://jestjs.io/

• https://github.com/nestjs/nest

• https://github.com/typeorm/typeorm

• https://github.com/nvm-sh/nvm