README.md

Whosbest API é um backend para a plataforma de competições e enquetes, Whosbest. Trata-se de uma Web API construída em Go com GraphQL para as requisições e WebSocket para uma análise em tempo real dos resultados. Além disso a persistência dos dados é feita em um banco PostgreSQL.

Referências

• go-graphql
• golang-jwt
• golang-migrate
• websocket

Variáveis de Ambiente

Para rodar esse projeto, você vai precisar adicionar algumas variáveis de ambiente no seu .env. De forma geral, recomendamos que o arquivo .env.example seja copiado, ele já fornece o mínimo necessário para iniciar o projeto, não sendo necessário configurações adicionais.

Rodando localmente

Clone o projeto

  git clone [email protected]:joaovicdsantos/whosbest-api.git

Entre no diretório do projeto

  cd whosbest-api

Execute as migrações

  docker compose --profile tools run migrate

Rode com docker compose

  docker compose up -d

Documentação da API

Cadastrar

  POST /register

Body	Tipo	Descrição
username	string	Nickname de usuário
password	string	Senha do usuário

Logar

  POST /login

Body	Tipo	Descrição
username	string	Nickname de usuário
password	string	Senha do usuário

  GET /graphql

Body	Tipo	Descrição
query	string	GraphQL query

Além destes, há o endpoint relacioando ao WebSocket.

 WEBSOCKET /ws

Licença

MIT

Autores

• @joaovicdsantos