Soccer Leaderboard

Boas-vindas ao repositório Soccer Leaderboard

Este repositorio apresenta uma API RESTful para gestão de uma tabela de campeonato de futebol é projetada para gerenciar partidas de futebol, fornecendo operações de CRUD (Create, Read, Update, Delete). Esta API permite criar partidas, atualizar os detalhes das partidas, finalizar partidas e visualizar as informações das partidas. Além disso, a API implementa autenticação e autorização para garantir que apenas usuários autorizados possam acessar e modificar os dados.

Tecnologias e Ferramentas Utilizadas

Tecnologias

• TypeScript
• Express
• MySQL
• JWT
• React

Ferramentas

• VSCode
• Docker
• Sequelize
• Insomnia
• Swagger

Como executar o Projeto

Instalação e Execução

1. Clone o repositório (Utilizar Link SSH)

2. Inicializar projeto

  npm install

3. Rodar os containers Docker

  npm run compose:up

Nota: Por padrão o Front-end estará rodando na porta 3000, o Back-end na porta 3001 e o Banco de Dados na porta 3306.

4. Parar os containers Docker

  npm run compose:down

Documentação

A documentação da API é gerada automaticamente através do Swagger e estará disponível através do endpoint http://localhost:3001/api-docs/ quando a aplicação estiver em execução. A documentação inclui detalhes sobre os endpoints disponíveis, os parâmetros necessários, os códigos de resposta e exemplos de solicitações.

Realização de Requisições

Este arquivo contém uma coleção de endpoints para a plataforma Insomnia, que podem ser importados diretamente para a aplicação, simplificando o processo de teste e interação com a API.

• Insomnia_leaderBoard.json

Contribuições

Yago Moreira

Trybe