Este projeto é uma cópia baseada no projeto do Waldemar Neto. Ele foi realizado seguindo os passos da playlist de aulas gratuítas disponibilizada no youtube.
Vale avisar sobre algumas diferenças entre os projetos.
- Foi adotado um modelo de exportação padrão (
export default) para as classes da aplicação. - A nomeação de classes foi feita usando uma convenção de nomes para descrever a sua funcionalidade, apesar da estrutura de pastas já deixar explícito.
Classes dentro dos diretórios
clients,controllers,modelseservicesforam acompanhadas respectivamente deClient,Controller,RepositoryeService. - As classes modelos (models) foram nomeadas com
Repositorypor me lembrar implementações feitas Java. - A classe
Requestimplementada pelo Waldemar foi renomeada paraHttpClientpor me lembrar de implementações feitas em Angular. - As funções de acessar e fechar o banco de dados foram colocadas em uma classe específica chamada
Databasepara manter as convenções. - Algumas declarações de tipos foram feitas de forma diferente como a do express porque resolvi seguir outros modelos encontrados pela internet.
- O estilizador de código do
prittierfoi removido em virtude da utilização do eslint para realizar este trabalho. - Foi adicionar a dependência do
pre-commitpara manter a qualidade de código. Para ignorar execuções das etapas durante o commit é necessário utilizar--no-verifyno comando decommit(ex:git commit --no-verify -m "msg"). - Alguns
comandosforam adicionados, removidos, ou renomeados do projeto original. - O
github workflowfoi configurado de forma distinta para evitar o deploy na master. - O
postman/insominiaforam descartados em virtude do desejo em utilizar oCURLem testes manuais, e assim ter um contato mais direto com ferramentas de terminal. - Foi utilizado o padrão
Factorypara evitar a passagem de classes concretas por construtor na classe 'ForecastService', como foi feito pelo Waldemar. Comentei no seu vídeo sobre e ele me pediu para realizar uma implementação para poder mostrar as diferenças de implementação. Este padrão é muito utilizado em Java e simplesmente exige uma interface intermediária que cria a classe alvo, neste caso era oRatingService. A classe concreta para este papel é aRatingServiceFactory. - O parametro da autenticação foi alterado de
x-access-tokenparaauthorization.
$ yarn # Para instalar as dependências
$ yarn dev # Inicializa o projeto em modo de desenvolvimento
$ yarn start # Inicializa o projeto em modo de produção
$ yarn test # Realiza todos os testes
$ yarn test:unit # Realiza todos os testes de unidade
$ yarn test:functional # Realiza todos os testes funcionaisCaso você tenham algum problema com o script encontrado em scripts/deploy.sh, vale lembrar que ele deve ter permissão de execução (ex: chmod +x scripts/deploy.sh).