Boas vindas ao repositório do projeto TFC

O que foi desenvolvido 👨‍💻

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

Nesse projeto, foi construido um back-end dockerizado que é consumido por um front-end já desenvolvido. com a modelagem de dados através do Sequelize.

---

Tecnologias utilizadas

• Node JS
• Express
• MySQL
• Sequelize
• Docker
• Mocha
• Chai
• Sinon

Orientações

⚠️ Configurações mínimas para execução do projeto

Na sua máquina você deve ter:

• Sistema Operacional Distribuição Unix
• Node versão 16
• Docker
• Docker-compose versão >=1.29.2

➡️ O node deve ter versão igual ou superior à 16.14.0 LTS:

• Para instalar o nvm, acesse esse link;
• Rode os comandos abaixo para instalar a versão correta de node e usá-la:
  • nvm install 16.14 --lts
  • nvm use 16.14
  • nvm alias default 16.14

➡️ O docker-compose deve ter versão igual ou superior àˆ1.29.2:

• Use esse link de referência para realizar a instalação corretamente no ubuntu;
• Acesse o link da documentação oficial com passos para desinstalar caso necessário.

🔰 Iniciando o projeto

1. Clone o repositório

• [email protected]:luizfilipelgs/Brazilian-Soccer-Rankings-TFC.git

2. Entre na pasta do repositório que você acabou de clonar:

• cd Brazilian-Soccer-Rankings-TFC

3. Instale as dependências (Isso ja ira instalar tanto o front quanto o backend).

• npm install

4. Execute o docker compose.

• npm run compose:up
• Obs: São utilizas as portas 3306, 3001 e 3000 , certifique-se que elas estão disponíveis no momento de executar o comando.

5. Para acessar.

• Porta Front-End - http://localhost:3000
• Porta Back-End - http://localhost:3001

Testes Integração Back-end

🛠 Execução de testes localmente

Para executar os testes localmente, basta executar o comando npm run test:coverage.

Você verá a lista de testes aprovados e a tabela de cobertura deles.

REST API

🚧 Documentação da API em Construção ! 🚧