Skip to content

ChampionTrackers/CTracker-server

Repository files navigation

CTracker Backend

Insomnia Badge

⚙️ Requisitos

🔨 Requisitos Funcionais

  • O usuário deve poder se cadastrar

  • O usuário deve poder se autenticar

  • O usuário deve poder visualizar a lista de campeonatos

  • O usuário deve poder visualizar o campeonato

  • O usuário deve poder visualizar o seu perfil

  • O usuário deve poder visualizar as equipes do campeonato

  • O usuário deve poder visualizar as partidas que ocorreram do campeonato

  • O usuário deve poder visualizar o histórico de pontos das equipes

  • O usuário deve conseguir realizar um palpite

  • O usuário deve conseguir visualizar seus palpites

  • O usuário deve conseguir visualizar a pontuação dos seus palpites

  • O organizador deve poder criar um campeonato

  • O organizador deve poder criar uma equipe

  • O organizador deve poder criar um jogador

  • O organizador deve poder adicionar jogadores nas suas equipes

  • O organizador deve poder adicionar equipes no campeonato

  • O organizador deve poder criar partidas

  • O organizador deve poder alterar o resultado das partidas

📋 Regras de Negócio

  • O organizador só pode inscrever jogadores em equipes com vagas disponíveis
  • O organizador só pode inscrever equipes no campeonatos com vagas disponíveis

🚀 Como executar o projeto

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

# Clone este repositório
$ git clone https://github.com/ChampionTrackers/CTracker-server.git

# Acesse a pasta do projeto no terminal
$ cd CTracker-server

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

Subindo o banco de dados utilizando docker

docker run -d \
  --name my-postgres \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=ctracker \
  -p 5432:5432 \
  postgres:alpine

ou

docker-compose -f docker-compose.dev.yml up -d

URL de conexão com o banco de dados

DATABASE_URL="postgresql://postgres:postgres@localhost:5432/ctracker?schema=public"