🌿 Projeto Eco Amigos (Backend)

Idealizado e implementado no Hackathon KipperDev 2024

Projeto

Proposta

Desenvolvimento de um aplicativo voltado para crianças a partir de 8 anos, utilizando a familiaridade delas com dispositivos eletrônicos, especialmente celulares. O objetivo do aplicativo é conscientizar sobre os efeitos climáticos, reciclagem, sustentabilidade e outros temas ambientais.

Mais informações: Documentação do Projeto

Desenvolvimento

Está é uma API desenvolvida utilizando Java 17 com o framework SpringBoot 3.3.2 e build da aplicação utilizando Apache Maven 3.8.7.

Para a camada de dados foi utulizado o PostgreSQL 14.2, e H2 Database para testes unitários.

E por fim, para a documentação da API foi utilizado o Swagger 3, inclusive, o Swagger de produção pode ser acessado.

Executando o projeto

Pré-requisitos

Para executar o projeto é necessário ter instalado:

Apache Maven:

sudo apt install maven

e o Java 17:

sudo apt install openjdk-17-jdk

Clonando o repositório

Primeiro, é preciso clonar o repositório:

git clone https://github.com/diegoborbadev/hackathon-kipper.git

Agora, acessar a pasta do projeto:

cd hackathon-kipper

Instalando dependências, compilando e executando

Para instalar as dependências, basta executar o comando:

mvn install

Para compilar e executar o projeto:

mvn spring-boot:run

Pronto! A API estará disponível em http://localhost:8080 e o painel do Swagger em http://localhost:8080/swagger-ui/index.html 🎉🎉.

Também é possível executar os testes unitários com o comando:

mvn test