Skip to content

geraldo-gja/java-project-template

Repository files navigation

🧩 Template for Spring Boot Project

This is a sample project created with Spring Boot 3.5.6, using Java 21 and Gradle (Groovy DSL) as the build tool.


🚀 Technologies Used

  • Java 21
  • Spring Boot 3.5.6
  • Gradle (Groovy DSL)
  • YAML for configuration (application.yaml)

Frameworks and Libraries

  • Lombok
  • H2 Database
  • MapStruct
  • Logging - endpoint interceptor
  • Colorized Console Logs
    use environment variable LOGGING_COLORS_ENABLED**
  • Swagger
    access the link: http://localhost:8080/swagger-ui/index.html**
  • Spring Boot Validation
  • Dockerfile
    build: docker build -t template-api-image
    docker run -d --name template-api -p 8080:8080 template-api-image
  • docker-compose build: docker compose build
    run: docker compose up

🔹 Prerequisites

  • Java 21 installed
  • Gradle 8+ (or use the included wrapper)
  • Compatible IDE (IntelliJ IDEA, VS Code, Eclipse, etc.)

🧰 Steps to Run

  1. Clone the repository
  1. Run with Gradle
  • ./gradlew bootRun
  1. Access the application

Run Tests

  1. To execute automated tests:
  • ./gradlew test

Build the Project

  1. Generate the .jar file:
  • ./gradlew build
  1. The final artifact will be created at:
  • build/libs/demo-0.0.1-SNAPSHOT.jar

💾 Access the H2 Console:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors