Uma aplicação desenvolvida em Typescript usando Nestjs Framework

JuliusReport Web-API

Descrição

Aplicação de controle financeiro veicular, alimentado pela entrada de dados do usuário.

Requisitos mínimos do sistema

Nodejs 8.11.3 ou superior
npm 6.5.0 ou superior
Docker 18 ou superior (apenas em desenvolvimento, para o banco de dados)

Variáveis de ambiente para produção

DB_HOST             # Endereço do servidor postgresql. Default localhost
DB_PORT             # Porta utilizada na conexão ao servidor psotgresql. Default 5432
DB_USER             # Usuário do banco de dados. Default julius
DB_PASSWORD         # senha do banco de dados. Default juliuspass
DB_SCHEMA           # Nome do banco de dados. Default juliusreport
DB_ORM_SYNC         # Liga ou desliga o sync do orm. Default false
NODE_ENV            # Ambiente de execução. Ajuste para 'production' em produção
PORT                # Porta onde a API vai ouvir. Default 3000
BISCOITO            # chave do cookie
API_PRIVATE_KEY     # chave da api para descriptografar tokens
VALIDADE_TOKEN      # Tempo de validade do token de autenticação: Default 1h

Instalação das dependências

$ npm install

Executando o serviço

Banco de dados

Utilize o script pré configurado no package. Ele levanta um banco de dados Postgresql já configurado para funcionar com a aplicação em ambiente de desenvolvimento.

npm run postgre:test

Subindo a aplicação

# development
$ npm run start

Documentação em Swagger

Acesse a rota /docs para conferir a documentação da api no Swagger

Testes automatizados

# Testes Unitários (testa os métodos em geral)
$ npm run test

# Testes e2e (testa as rotas)
$ npm run test:e2e

# Testa a cobertura total de testes no projeto
$ npm run test:cov