Vehicle Catalog Java API

---

Sumário desta Documentação

• Rodando o projeto na sua máquina
• Configurões de banco de dados
• Pipeline
• Rodando o projeto com Docker
• Rodando o projeto na sua máquina
• Configurões do banco de dados
• Acessando o projeto como administrador
• Documentação da API com Swagger UI
• Como contribuir

---

Rodando o projeto com Docker é a forma que eu recomendo

1. docker pull pedroluiznogueira/vehicle-catalog-api:0.0.2-SNAPSHOT
2. docker run -p 8080:8080 pedroluiznogueira/vehicle-catalog-api:0.0.2-SNAPSHOT
3. Abra outro terminal
4. docker ps, a imagem do projeto estará rodando em um container
5. Em seu browser acesse http://localhost:8080/swagger-ui.html
6. Se a interface do Swagger com a documentação da API aparecer, tudo ocorreu bem e o projeto está pronto para uso local

---

Pipeline

• Caso queira acessar a branch de produção do projeto, acesse a branch master
• Ela está configurada com o pipeline para fazer deploy contínuo
• A branch utilizada em desenvolvimento contínuo é a branch developer

---

Como rodar este projeto na sua máquina local

1. git clone https://github.com/pedroluiznogueira/sps-react.git
2. Abra o projeto clonado em sua IDE/Editor de texto de preferência
3. Abra a pasta do projeto no terminal
4. Digite "npm install" e aperte enter
5. git fetch
6. git checkout release/v.1.1 (essa é a branch do projeto finalizado configurado para rodar localmente)
7. Rode o projeto

---

Configurões de banco de dados

-> A branch release/v.1.1 está configurada para rodar com um banco h2 em memória
-> Quando o projeto é iniciado alguns dados já são persistidos por meio de um script
-> É necessário fazer registro de usuário e login

Acessando o projeto como administrador

1. Se registre como qualquer email e password, mas no campo name é necessário escrever admin
   
2. Faça login com o email e password que você se registrou
3. Você verá os ícones que dão acesso ao painel de administrador

---

Documentação da API podendo ser acessar no Swagger UI

-> Após rodar a aplicação, acesse: http://localhost:8080/swagger-ui.html

---

Contribuições

-> Sinta-se livre para abrir contribuir para esse projeto seguindo os seguintes passos:

1. Dê Fork neste projeto
2. Faça suas mudanças e suba-às para o seu repositório forkeado
3. Abra um Pull Request para a branch DEVELOPER deste projeto

---