Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Desafio Votação - Gabriel Ramirez #78

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

GabrielRRamirez
Copy link

Votação

API desenvolvida para o processo seletivo Sicredi, em parceria com a DB.


Requisitos Mínimos

Para executar a aplicação fora do ambiente de containers, é necessário ter instalado:

  • Java - versão 17
  • PostgreSQL - versão 12

Para executar a aplicação dentro de containers, é necessário apenas ter o Docker instalado.


Instruções de Uso

Configuração do Ambiente

A aplicação utiliza um arquivo .env para facilitar a escalabilidade e garantir a segurança das configurações sensíveis.

  1. Crie o arquivo .env no diretório principal do projeto (exemplo: ~/DesafioVotacao/.env) com as seguintes propriedades:

    Variável Descrição
    DB_PORT Porta do banco de dados
    DB_NAME Nome do banco de dados
    DB_USER Nome do usuário do banco de dados
    DB_PASS Senha do banco de dados
    DB_HOST IP do banco de dados (se estiver executando a aplicação no container, deve ser postgres)
    APPLICATION_PORT Porta da aplicação
  2. Após a criação do arquivo com as variáveis necessárias, execute o seguinte comando para subir os containers:

    docker-compose up -d

Testes de Funcionalidade

Para facilitar o teste das funcionalidades da API, você pode importar a collection do Postman:

  • Arquivo: desafio-votacao.postman_collection.json
  • Localização: Diretório principal do projeto

Essa collection já contém as rotas e exemplos de requisições para facilitar os testes.


Documentação

Para visualizar a documentação dos recursos disponibilizados para acesso na API, visite o endereço:

localhost:${APPLICATION_PORT}/swagger-ui/index.html#/ 

Observação: Substitua ${APPLICATION_PORT} pela porta definida para a aplicação no arquivo .env

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant