Trybe Futebol Clube

             

O TFC é uma aplicação web que fornece informações sobre partidas e classificações de futebol. Foi desenvolvida uma Rest API utilizando o método TDD e integrou as aplicações por meio do docker-compose para consumir um banco de dados.

O objetivo do projeto foi desenvolver um back-end dockerizado utilizando modelagem de dados por meio do ORM Sequelize. A API criada segue as regras de negócio fornecidas pelo projeto e foi capaz de ser consumida por um front-end já provido pelo time de desenvolvimento da Trybe.

Para adicionar uma partida, é necessário estar logado e possuir um token de autenticação. Haverá um relacionamento entre as tabelas teams e matches para fazer as atualizações das partidas. O back-end implementa regras de negócio para popular adequadamente a tabela disponível no front-end, que será exibida para a pessoa usuária do sistema.

⚙️ Instalação e Uso

Você precisa ter o node instalado em seu computador para executar este projeto. Este projeto foi criado usando a versão v16.15.1. Você precisa ter o docker e o docker compose cli instalados em seu computador para executar este projeto. Este projeto foi criado usando as versões v20.10 e v1.29 respectivas.

Para executar esta aplicação, você precisa fazer o clone para seu computador:

git clone git@github.com:oleoprado/trybe-futebol-clube-backend.git

Entre no diretório:

cd trybe-futebol-clube-backend

Instalar as depedências:

npm install

Rodar o script para subir o container:

npm run compose:up

Rodar o script para descer o container:

npm run compose:down

A aplicação estará acessível:

Front-end: https://localhost:3000
Back-end: https://localhost:3001

Para rodar os testes de integração das camadas:

npm run test

✉️ Contato

📝 Licença