[INSIRA DESCRICAO DO PROJETO AQUI]
Para que seja possível rodar essa aplicação é necessário atender alguns requisitos básicos.
- Java 8+
- Maven 3.3+
Assim como todo projeto Maven, é necessário primeiramente realizarmos a geração dos fontes. Conforme o exemplo abaixo:
mvn clean install[INSIRA PARTICILARIDADES DO PROJETO AQUI]
Certifique-se de o repositório do Maven está corretamente configurado. Após os fontes terem sido gerados, basta executar o comando abaixo para inicializar a aplicação:
$ java -jar NAME-SNAPSHOT.jar
Ou, se tiver importado por meio do IntelliJ, via classe Application.java. Para validar se a aplicação inicializou com
sucesso é necessario chamar o endpoint do actuator através do link abaixo:
http://localhost:8080/actuator/health
Assim que o projeto estiver sendo executado, é possível verificar as APIs expostas acessando a URL:
http://localhost:8080/swagger-ui.html
Abaixo uma lista de informações relevantes para iniciar o projeto:
- Em caso de utilização local ...
- [Aplicação de referência](colocar o link de referência)
- [Documentação de referência](colocar link da documentação de referência)
- [Modelo arquitetural](Caso você esteja seguindo algum padrão descrever aqui)
- [Stack de tecnologias](precisamos definir uma stack padrão e colocar o link aqui)
- [Scaffolding](Precisamos definir um Scaffolding para utilização em novos projetos)
- [Pipeline](Orientações para gerar versão para produção)