genc / spring-boot-boilerplate

Spring Boot Boilerplate is a starter kit. This project includes : Spring Boot(v2.7.10), Spring Data JPA, Spring Validation, Spring Security + JWT Token, PostgreSQL, Mapstruct, Lombok, Swagger (Open API)

Spring Boot Boilerplate

Spring Boot Boilerplate is a starter kit. This project is a very simple and useful.

Technologies

• Spring Boot (v2.7.10)
• Spring Data JPA
• Spring Validation
• Spring Security + JWT Token
• PostgreSQL
• Mapstruct
• Lombok
• Swagger (Open API)

Customization

• You can customize token information (secret key, issuer, expiry date) in application.yml file.
• You can customize database connection information in application.yml file.
• You can customize swagger information in application.yml file.
• You can customize which endpoints are accessible without token information in SecurityConfiguration.java file.

Run the Application

First you need to make sure that the database is up. If you're using Docker, you can use docker compose up -d command. (If you have made changes in local, you should use the local-docker-compose file.)

Navigate to the root of the project. For building the project using command line, run below command :

mvn clean install

Run service in command line. Navigate to target directory.

java -jar spring-boot-boilerplate.jar

Postman Collection

• You can access the Postman collection here and you can try it after you get the project up and running.

Others

• For Angular

License

Apache License 2.0

spring-boot-boilerplate's Issues

Logging

I will overhaul the logging parts

Exception Handling

I will improve error handling

Error on Macbook Air M1: no matching manifest for linux/arm64/v8 in the manifest list entries

no matching manifest for linux/arm64/v8 in the manifest list entries

Spring (2.7.10) & Dependencies Version Upgrade

• Spring
• Mapstruct
• Lombok
• JWT
• Swagger UI

I will upgrade version all of them

Edit Readme File

Docker -- docker compose up
Version Number
Fixme & Todo comments

Change artifact id and packaging structure

The booilerplate.design address was mine but I didn't renew it. So I will update the project structure and artifact name.

Dockerize

Currently only database (postgresql) is running as docker. I will also do this within the application itself.