Skip to content

Latest commit

 

History

History
132 lines (90 loc) · 3.34 KB

README.md

File metadata and controls

132 lines (90 loc) · 3.34 KB
Raw

⚽️ Brasileirão Feminino A1

Sistema em React (frontend e backend) de gestão do Campeonato Brasileiro Feminino de 2023 (Série A1).

(Atualizado até a 2a rodada, em 07/março/2023)

🔗 Links

portfolio linkedin twitter

Instruções de utilização

  1. Clone o projeto
  gh repo clone devsakae/brasileiraofeminino
  • Usando SSH:
  git clone git@github.com:devsakae/brasileiraofeminino.git

Após isso, acesse a pasta do projeto:

  cd brasileiraofeminino
  1. Instale as dependências
  npm install
  1. Rode com Docker (docker-compose na pasta app/)
  cd app/ 
  docker-compose up -d

O projeto está preparado para rodar na portão 3000 (padrão) http://localhost:3000

Documentação da API

✅ Retorna todos os times

  GET /teams

✅ Retorna um único time (pelo id)

  GET /teams/${id}

✅ Devolve um token após login

  POST /login

Necessário informar um objeto no body com os parâmetros abaixo definidos:

Parâmetro Tipo Descrição
email string Obrigatório. O email inicial é admin@admin.com
password string Obrigatório. A senha inicial é secret_admin

✅ Retorna o role do usuário logado

  GET /login/role

🛑 Para esta rota, você precisará informar o token no Headers da requisição.

✅ Busca todas as partidas

  GET /matches

✅ Busca todas as partidas em andamento

  GET /matches?inProgress=${boolean}

Informe true para partidas em andamento ou false para partidas finalizadas.

✅ Inserindo uma nova partida

  POST /matches

Essa rota recebe os parâmetros abaixo em seu body, com validações do token e dos ids (que existam e que não sejam iguais).

Parâmetro Tipo Descrição
homeTeamId number Obrigatório. O ID do time mandante
awayTeamId number Obrigatório. O ID do time visitante
homeTeamGoals number Obrigatório. O número de gols marcado pelo mandante
awayTeamGoals number Obrigatório. O número de gols marcado pelo visitante

✅ Editar partida

  PATCH /matches/${id}

| homeTeamGoals | number | Obrigatório. O número de gols marcado pelo mandante | | awayTeamGoals | number | Obrigatório. O número de gols marcado pelo visitante |

✅ Finalizar partida em andamento

  PATCH /matches/${id}/finish

Esta rota finaliza a partida em andamento de número ${id}.

Stacks utilizadas

Frontend: React

Backend: NodeJs, Express, Joi

Licença

MIT