muriloalvesdev / buy-manager Goto Github PK

Apache License 2.0

• Spring Boot - Framework de Desenvolvimento para a Linguagem Java.

• Lombok - Biblioteca Java focada em produtividade e redução de código boilerplate que, por meio de anotações adicionadas ao nosso código, ensinamos o compilador (maven ou gradle) durante o processo de compilação a criar código Java.

• JUnit5 - Framework facilita a criação e manutenção do código para a automação de testes com apresentação dos resultados.

• Mockito - Estrutura de teste de código aberto para Java liberada sob a licença MIT. A estrutura permite a criação de objetos duplos de teste em testes de unidade automatizados com o objetivo de desenvolvimento orientado a teste ou desenvolvimento orientado a comportamento.

• PostgreSQL - Banco de dados.

• Hibernate - Framework para persistência de dados. (ORM)

• JPA - Especificação do Java que dita como os Frameworks ORM devem ser implementados.

• Docker - Plataforma open source que facilita a criação e administração de ambientes isolados. Ele possibilita o empacotamento de uma aplicação ou ambiente dentro de um container, se tornando portátil para qualquer outro host que contenha o Docker instalado.

• Swagger - Essencialmente uma linguagem de descrição de interface para descrever APIs RESTful expressas usando JSON.

• Maven - Ferramenta de automação de compilação utilizada primariamente em projetos Java.
• Docker - Execução de aplicativos de containers.

• Clone o projeto: $git clone https://github.com/muriloalvesdev/buy-manager.git
• Após concluir o Download do projeto, acesse o diretório do mesmo: $cd buy-manager/

OBS: Sobre a instalação existem duas formas, abaixo está o passo a passo, sobre como realizar este procedimento. 
Mas caso você queira instalar rapidamente o projeto, basta executar o script contido na raiz do projeto: 
$./docker-run.sh

• Para instalar as dependências e executar os testes, utilize o comando: $mvn clean package

• Execute o script $./docker-run.sh para construir a aplicação. Este script compila o projeto com o profile de PROD, cria uma imagem Docker da aplicação e por fim utiliza o Docker Compose para baixar a imagem do PostgreSQL (banco de dados) e sobe a aplicação.
• Após executar o script você ja deve ter a aplicação sendo executada.

OBS: O projeto é executado na porta 8080 e o banco de dados é executado na porta 5432, verifique se essas 
portas estão disponíveis caso ocorra algum erro. Tenha certeza de que você está com o Docker e o 
Maven instalados para que você não tenha problemas ao compilar, testar e executar a aplicação.

Caso você queira apenas baixar a imagem e executar a aplicação, basta seguir os passos abaixo: OBS: Você precisa ter o PostgreSQL pré instalado com um database chamado "buy_manager" .

• Baixe a imagem Docker, utilizando o comando: $docker pull muriloalvesdev/buy_manager
• Execute o comando $docker run <id_imagem> para executar o container.
• E agora você ja deve ter a aplicação sendo executada.