victorb26/battle-cards

Api Multiversus TCG, realizado durante processo seletivo do programa SomoS da Iteris INC.

Desafio SomoS - MultiVersus TCG

Descrição

Este projeto é uma API que simula um Trade Card Game com a temática do jogo MultiVersus da Warner.

Pré-requisitos para rodar em sua máquina

Antes de iniciar, se assegure que possui os requisitos abaixo:

• IDE - (Por exemplo, o Visual Studio Code)
• Node.js
• Git
• Cadastro no MongoDB Atlas

Instalação/Execução

1. Instale o Node.js.

2. Faça o download como ZIP clicando neste link) e extraia a pasta no local de sua preferência ou siga o passo a passo para fazer a instalação através do terminal do Git:

# Navegue pelos arquivos com o comando "cd" e faça o download do projeto

# Via SSH
$ git clone [email protected]:victorb26/battle-cards.git
# ou via HTTPS
$ git clone https://github.com/victorb26/battle-cards.git

# Após o download, entre na pasta raiz da aplicação
$ cd BATTLE-CARDS

3. O projeto armazena as cartas e resultados por meio do MongoDB. Edite o arquivo configDB de acordo com seus dados fornecidos pelo MongoDB Atlas.

4. Instale as dependências necessárias e inicie a aplicação.

$ npm install

$ npm start

Rotas

• GET
  • Consulte todas as cartas já cadastradas
    • '/characters'
  • Consulte uma carta específica através de seu id
    • '/character' + /{insira aqui a id desejada}
  • Consulte o resultado acumulado de vitórias de cada jogador
    • '/scores'
• POST
  • Insira um nova carta com um personagem
    • '/character'
  • Jogue contra outro Player
    • '/battle'
  • Reinicia a contagem de vitórias acumuladas
    • '/reset'
• PATCH
  • Atualize uma carta já existente, totalmente ou por atributo específico
    • '/character' + /{insira aqui a id desejada}
• DELETE
  • Remova uma carta específica através de seu id
    • '/character' + /{insira aqui a id desejada}

A operação GET pode ser acessada através de seu navegador de preferência, enquanto que para a utilização das demais é recomendado fazer as requisições por meio de API clients como Postman ou Insomnia.

SOBRE

Este projeto foi desenvolvido durante processo seletivo da Iteris INC.

Autor: Victor Barros