/trybe-futebol-clube

O TFC é um site informativo sobre partidas e classificações de futebol! ⚽️

Primary LanguageTypeScript

Boas vindas ao repositório do Trybe Futebol Clube!!

O TFC é um site informativo sobre partidas e classificações de futebol! ⚽️

Nesse projeto, está construido um back-end dockerizado utilizando modelagem de dados através do Sequelize. O desenvolvimento foi respeitado as regras de negócio providas no projeto e sua API, capaz de ser consumida por um front-end já provido nesse projeto.

Estrutura do projeto

O projeto é composto de 4 entidades importantes para sua estrutura:

1️⃣ Banco de dados:

  • Um container docker MySQL já configurado no docker-compose através de um serviço definido como db.
  • Tem o papel de fornecer dados para o serviço de backend.
  • Durante a execução dos testes sempre vai ser acessado pelo sequelize e via porta 3306 do localhost;
  • Você também pode conectar a um Cliente MySQL (Workbench, Beekeeper, DBeaver e etc), colocando as credenciais configuradas no docker-compose no serviço db.

2️⃣ Back-end:

  • Foi o ambiente que realizei a maior parte das implementações exigidas.
  • Deve rodar na porta 3001, pois o front-end faz requisições para ele nessa porta por padrão;
  • Sua aplicação deve ser inicializada a partir do arquivo app/backend/src/server.ts;
  • Garanta que o express é executado e a aplicação ouve a porta que vem das variáveis de ambiente;
  • Todas as dependências extras (tal como joi, boom, express-async-errors...) devem ser listadas em app/backend/packages.npm.

3️⃣ Front-end:

  • O front já estava concluído, não foi necessário realizar modificações no mesmo. A única exceção será seu Dockerfile que foi preciso ser configurado.
  • Todos os testes a partir do requisito de login usam o puppeteer para simular uma pessoa acessando o site http://localhost:3000/;
  • O front se comunica com serviço de back-end pela url http://localhost:3001 através dos endpoints que você deve construir nos requisitos.

4️⃣ Docker:

  • O docker-compose tem a responsabilidade de unir todos os serviços conteinerizados (backend, frontend e db) e subir o projeto completo com o comando npm run compose:up;