Introdução | Tecnologias | Estrutura | Instalação | Endpoints | Comentários Adicionais |
Tweet Analyzer é uma API proposta no desafio prático de back-end da empresa QR Capital que tem como objetivo analisar tweets sobre bitcoin e retornar a média da opinião do usuário usando o algoritmo Vader Sentiment e salvando os dados usando SQLite.
A aplicação foi construída utilizando Node.js com Express.
Para os testes, foi utilizado o Jest.
Para padronizar o código e manter a qualidade, foram utilizados, em conjunto: Editor Config, Prettier e ESLint
Além disso, outras bibliotecas foram utilizadas para auxiliar na implementação das funcionalidades, sendo elas:
Babel: Utilizado para fazer a build do código e também cuidar da compatibilidade do código com os testes, convertendo os decorators, por exemplo.
Class Transformer: Utilizados alguns decorators para não trazer informações como data de criação no corpo da resposta.
Tsyringe: Biblioteca que facilita a injeção de dependências.
TypeORM: Biblioteca utilizada para facilitar a interação com o banco de dados, aproximando o paradigma do banco de dados ao paradigma da orientação a objetos.
UUID: Universal Unique ID, usado para gerar id's únicos nas entradas no banco.
Pasta raíz: Configurações das ferramentas e bibliotecas.
assets -> Contém as imagens que serão usadas nesse readme.
coverage -> Pasta que foram gerados os relatórios dos testes.
src -> A pasta principal da aplicação, contendo:
dtos (Data transfer objects) -> As interfaces que definem a estrutura dos dados que serão passados para os services;
modules -> Pasta que abstrai os módulos da aplicação, podendo usar
como referência as tabelas do banco de dados (cada tabela seria um
module). Dentro dos **modules** temos a seguinte estrutura:
infra/http -> Contém os controllers e rotas.
infra/typeorm -> Contém toda a lógica utilizada em conjunto com o
Typeorm (Entidades e repositórios), abstraindo o uso da biblioteca
e não deixando a aplicação dependente dela.
repositories -> Contém as interfaces que definem a estrutura que
os repositórios deverão seguir.
repositories/fakes -> O fake do repositório que será utilizado nos testes.
services -> Contém os serviços que são responsáveis por chamar
os repositórios e pelas regras de negócio da requisição.
services/__tests__ -> Testes unitários realizados com o Jest.
types -> Tipagem de alguns modelos de dados.
shared -> Pasta que contém os módulos principais e que serão
compartilhados entre os módulos.
container -> Contém as dependências que serão injetadas.
errors -> Contém a estrutura da classe dos erros personalizados.
A pasta infra já teve sua explicação acima.
1 - Clone o projeto;
2 - Execute o comando yarn para instalar as dependências;
3 - Execute o comando yarn dev para rodar a aplicação;
4 - É possivel executar yarn test para executar os testes ou yarn test:watch para executar ficar observando os testes.
[POST] http://localhost:3333/opinion -> Enviar os dados em JSON para analisar o tweet, exemplo:
{
"author": "michael_saylor",
"text": "Beginning is easy, continuing is hard. -Japanese proverb on #Bitcoin",
"link": "https://twitter.com/michael_saylor/status/1406936342664290307"
}
[GET] http://localhost:3333/opinion/autor -> Enviar o nome do autor no final do endpoint, exemplo: http://localhost:3333/opinion/michael_saylor.
Exemplo de resposta:
1 - Usei o synchronize: true no banco para agilizar e focar na parte mais importante da aplicação.
2 - A maior parte dos conceitos aplicados nesse teste, aprendi pesquisando para fazer os projetos para trabalho/estudo e assistindo os cursos: