davyguedes / cardatabase

Cardatabase

Projeto em desenvolvimento de uma aplicação usando Spring Data REST, baseada na aplicação construída no decorrer do livro de Juha Hinkula, Hands-On Full Stack Development with Spring Booot 2.0 and React, com algumas alterações.

Tecnologias utilizadas

• Java 11
• Maven
• Spring Boot
• Spring Data REST
• Spring Security
• Swagger
• Docker
• Travis CI

Utilização e build

Após a inicialização da aplicação, independente da forma, a mesma pode ser acessada ou ter a sua documentação acessada pelo link http://localhost:PORTA_INICIADA/swagger-ui.html, exemplo: http://localhost:8080/swagger-ui.html.

Build usando artefatos locais (GIT)

OBS: Os arquivos e ferramentas de build, estão contidas dentro do projeto, então para execução do build, só é necessário ter o Java ou o Docker instalado.

Build local com Maven

# Execução do build
./mvnw build
# Execução da aplicação
java -jar  target/cardatabase-0.0.1-SNAPSHOT.jar

OBS: Com esses comandos a aplicação será iniciada, na porta 8080, mas isso pode ser alterado, informando o parâmetro: -Dserver.port=$PORTA_DESEJADA.

Build local com Docker

# Execução do build
docker build -t marcosdavy/cardatabase:latest .
# Execução da aplicação
docker run -d -p 8080:8080 marcosdavy/cardatabase:latest

OBS: Com esses comandos a aplicação será iniciada, na porta 8080, mas isso pode ser alterado, informando o parâmetro docker: -p $PORTA_DESEJADA:8080.

Utilização com Docker (imagem remota do DockerHub)

# Execução da aplicação
docker run -d -p 8080:8080 marcosdavy/cardatabase:latest

OBS: Com esse comando a aplicação será iniciada, na porta 8080, mas isso pode ser alterado, informando o parâmetro docker: -p $PORTA_DESEJADA:8080.

Arquivo e artefatos do projeto

Arquivo ou diretório	Descrição
.mvn/*, mvnw, mvnw.cmd	Arquivos e diretórios de instalação do Maven, com eles no projeto, não é necessário instalar o Maven separadamente
pom.xml	Arquivo com as configurações de dependências e de build do Maven
Dockerfile	Arquivo com as configurações para criação da imagem Docker, nesse Dockerfile é utilizado a estratégia multi-stage builds
.travis.yml	Arquivo com as configurações de build contínuo, no caso desse projeto possui as configurações de build, testes e push da imagem Docker para o DockerHub
src/main/**/domain/{CarRepository, OwnerRepository, UserRepository}.java	Interfaces com as funcionalidades referentes aos endpoints da aplicação
src/main/**/domain/{Car, Owner, User}.java	Interfaces com as funcionalidades referentes aos endpoints da aplicação
src/main/resources	Diretório com as configurações da aplicação
src/main/resources/application.properties	Arquivo de configuração do Spring Boot

To Do

• Configurar projeto
• Entidade Car
• Entidade Owner
• Implement JSON Web Token (JWT)
• Create units tests

Créditos

• { README.md, Dockerfile } inspirado em @justiandre/justiandre-exemplo-kotlin-paineltarefas