Lis Beer 🍺

🚧 🚀 Em construção... 🚧

Tabela de conteúdos

• Sobre
• Features
• Pré-Requisitos
• Tecnologias

Sobre

O Lis Beer nasseu com o objetivo de promover a conexão entre os clientes e as Beers ( Cervejas ) mais próximas de sua casa.

Features

• | Cadastro de usuário
• | Cadastro de Loja
• | Obter informações de uma Beer em específico
• | Visualizar as Beers disponíveis
• | Cadastrar um nova Beer
• | Inserir uma nova categoria
• | Swagger

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, sdkman, Docker Desktop e o JDK16 do Java.

Você pode instalar o java atraves do sdkman:

# openJDK 16.0.2
$ sdk install java 16.0.2-open

Além disto é bom ter um editor para trabalhar com o código como o Intellij ou VSCode

🎲 Rodando o Back End (servidor)

# Clone este repositório
$ git clone https://github.com/Jose-Isaac/lis-beer-api.git

Abra o projeto no intellij ou se preferir via comando line:
# Vá para a pasta desse projeto
$ cd ./lis-beer-api

# Instale as dependências
$ ./gradle build

# Será necessãrio a criação das seguintes variáveis de ambiente:
- RDS_HOSTNAME
- RDS_PORT
- RDS_DB_NAME
- RDS_USERNAME
- RDS_PASSWORD
- JWT_SECRET

# Valores default local:
- RDS_HOSTNAME=localhost;
- RDS_PORT=5432;
- RDS_DB_NAME=lis-beer;
- RDS_USERNAME=development;
- RDS_PASSWORD=development;

- JWT_SECRET=algum-valor-seguro

# Essas variáveis são utilizadas no nosso application.properties que fica localizado em:
$ cd /src/main/resources

# Você pode iniciar o banco de dados pelo docker do projeto, acesse a pasta docker:
$ cd docker

# Com o docker iniciado, rode o seguinte comando:
$ docker-compose -f docker-compose-dev up

O servidor inciará na porta 8080 - acesse <http://localhost:8080>

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto: