jacksonemmerich / spring-boot-project-example

Spring Boot Project Example by Evren Tan

A Complete Spring Boot Example Project

A Complete Spring Boot Example Project with Spring Boot 2.6.2, JDK 17 & Maven.

Table of Contents

1. How to Contribute
2. Requirements
3. Running the Application Locally
4. Run Actuator
5. Run Swagger UI Documentation
6. Javadoc
7. Copyright

How to Contribute

For the contributor covenant to this project, please check the Code of Conduct file.

Requirements

For building and running the application belows are required;

• Spring Boot 2.6.2
• JDK 17
• Maven 3.8.3
• Springfox Boot Starter 3.0.0 for Swagger UI Documentation
• MongoDB

Running the application locally

The project can be booted with Spring Cloud Config Server or directly within the application. In order to boot the project within itself, enable the properties in application.properties file and disable bootstrap.properties file.

Application can be run with SpringBootProjectExampleApplication class under evrentan.examples.springbootprojectexample.spring.config.spring package.

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

Run Actuator

Spring Boot Actuator can be reached from local url for Actuator.

Only health and caches endpoints are enabled by default. Configuration can be updated within the "actuator" section of the related application.properties file. This file can be also in Spring Cloud Config Server if the application is booted with Spring Cloud Config Server.

Javadoc

You can create Javadoc with the below command or directly from your IDE.

mvn javadoc:javadoc

Run Swagger UI Documentation

After running the application, just type the local url for Swagger UI in your browser.

Extra Notes

This repo was made with love using GitKraken Client.

Copyright

GNU General Public License v3.0 Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.