⚽️ Seja bem vindo ao meu TFC (Trybe Futebol Clube)🏆

A partir de uma aplicação Front-End desenvolvida pela Trybe, foi desenvolvido um API para prover as informações necessárias para um site informativo sobre partidas e classificações de futebol!

• Construída com Node.js, Express, Typescript, MySQL, Sequelize e Docker
• Utilizando os princípios SOLID e Programação Orientada a Objetos
• Aplicando Arquitetura de Software, com as camadas de Modelo, Serviço e de Controladores
• Testes de Integração criadas utilizando Mocha, Chai, ChaiHTTP e Sinon

Qual o diferencial deste código?

Essa é a minha Obra Prima, me dediquei muito a construir o front-end, e ele foi feito com perfeição, usando um único handler de erro capaz de administrar erros de vários tipos, foi feito completamente em Typescript pensando em escalabilidade, todo código é extremamente legível e resumido, todas as funções são bem framentadas por necessidade, toda estrutura do Back-end feita em MSC é pensada para o código principal só rodar depois de todas as validações passarem, de fato, uma obra de arte.

Instruções

• Para rodar o repositório localmente, realize o clone deste repositório com git clone, depois disso, abra a pasta e rode npm install, esse script vai instalar todas as dependencias do front e back.

Rode isso caso queira iniciar ou parar os containers da aplicação

npm run compose:up
npm run compose:down // para parar completamente a aplicação

Para ver o front-end basta ir em https://localhost:3000/!

Caso queira executar os testes

cd app/backend
npm test

E utilize os comandos a seguir para executar os testes de integração criado:

Demonstração

Endpoints do Back-End

Login

Método	Funcionalidade	URL
POST	Realiza o login do usuário	http://localhost:3001/login
GET	Avalia se o usuário é o administrador	http://localhost:3001/login/validate

Nessa requisição POST é necessário informar o seguinte JSON:

{
  "email": "Nome do Usuário",
  "password": "senha_secreta"
}

Times

Método	Funcionalidade	URL
GET	Retorna todos os times cadastrados	http://localhost:3001/teams
GET	Retorna um time específico	http://localhost:3001/teams/:id

Partidas

Método	Funcionalidade	URL
GET	Retorna todos as partidas cadastradas	http://localhost:3001/matches
GET	Retorna todos as partidas cadastradas em progresso	http://localhost:3001/matches?inProgress=true
GET	Retorna todos as partidas cadastradas finalizadas	http://localhost:3001/matches?inProgress=false
POST	Criação de uma nova partida	http://localhost:3001/matches
PATCH	Atualiza a chave 'inProgress' para finalidado de uma partida específica	http://localhost:3001/matches/:id/finish
PATCH	Atualiza os gols de uma partida específica	http://localhost:3001/matches/:id

Nessa requisição POST é necessário informar o seguinte JSON:

{
  "homeTeam": 16, // O valor deve ser o id do time
  "awayTeam": 8, // O valor deve ser o id do time
  "homeTeamGoals": 2,
  "awayTeamGoals": 2,
  "inProgress": true
}

e na requisição PATCH para atualizar os gols realizados é necessário informar o seguinte JSON:

{
  "homeTeamGoals": 3,
  "awayTeamGoals": 1
}

Placar

Método	Funcionalidade	URL
GET	Retorna a classificação geral dos times	http://localhost:3001/leaderboard
GET	Retorna a classificação dos times mandantes	http://localhost:3001/leaderboard/home
GET	Retorna a classificação dos times visitantes	http://localhost:3001/leaderboard/away