Create Spring Boot Java Project

Spring Boot Java project creation

Create a Java 21 Spring Boot Maven project from Spring Initializr, add project dependencies and local service configuration, and verify the generated skeleton with Maven tests.

When to invoke

• "Create a Spring Boot Java project."
• "Scaffold a Java 21 Spring Boot Maven app."
• "Generate a Spring Boot skeleton with JPA, Redis, MongoDB, and PostgreSQL."
• "Set up docker-compose for a new Spring Boot app."

Prerequisites and context

• Java 21 must be installed; verify with java -version.
• Docker and Docker Compose must be installed before running local Redis, PostgreSQL, or MongoDB.
• Use the requested project name; otherwise use demo-java for artifactId and com.example for packageName.
• Use Spring Boot 3.4.5 unless the user requests another bootVersion; this replaces the old download-spring-boot-project-template anchor workflow.

Procedure

1. Verify Java:

java -version

2. Download the Spring Initializr template. Change artifactId, packageName, or bootVersion only when the user asks.

curl https://start.spring.io/starter.zip   -d artifactId=${input:projectName:demo-java}   -d bootVersion=3.4.5   -d dependencies=lombok,configuration-processor,web,data-jpa,postgresql,data-redis,data-mongodb,validation,cache,testcontainers   -d javaVersion=21   -d packageName=com.example   -d packaging=jar   -d type=maven-project   -o starter.zip

3. Unzip and remove the archive:

unzip starter.zip -d ./${input:projectName:demo-java}
rm -f starter.zip
cd ${input:projectName:demo-java}

4. Add dependencies to pom.xml:

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.8.6</version>
</dependency>
<dependency>
  <groupId>com.tngtech.archunit</groupId>
  <artifactId>archunit-junit5</artifactId>
  <version>1.2.1</version>
  <scope>test</scope>
</dependency>

5. Add application.properties settings for SpringDoc, Redis, JPA, and MongoDB:

springdoc.swagger-ui.doc-expansion=none
springdoc.swagger-ui.operations-sorter=alpha
springdoc.swagger-ui.tags-sorter=alpha
spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.******
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=postgres
spring.datasource.******
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=root
spring.data.mongodb.******
spring.data.mongodb.database=test

6. Create docker-compose.yaml at the project root with redis:6, postgresql:17, and mongo:8 services.

7. Add redis_data, postgres_data, and mongo_data to .gitignore.
8. Validate the project:

./mvnw clean test

9. Optionally run locally:

docker-compose up -d
./mvnw spring-boot:run
docker-compose rm -sf

The optional run commands are docker-compose up -d, ./mvnw spring-boot:run, and docker-compose rm -sf.

Project configuration rules

Gotchas

• Do not leave starter.zip behind; remove it after unzipping.
• Do not start services before Docker is available; project generation can complete without running containers.
• Do not use real passwords in application.properties; the shown ****** placeholders mark values that must be supplied safely.
• Do not skip .gitignore data directories; local databases create large mutable files.

Output template

## Spring Boot project result

**Status:** created | blocked
**Project:** `<projectName>`
**Package:** `<packageName>`
**Spring Boot:** `<bootVersion>`

### Files configured
| File | Change |
| --- | --- |
| `pom.xml` | <dependencies added> |
| `src/main/resources/application.properties` | <settings added> |
| `docker-compose.yaml` | <services added> |
| `.gitignore` | <data directories ignored> |

### Validation
- `java -version`: <result>
- `./mvnw clean test`: <pass|fail and evidence>

Quality gate

• Java 21, Docker, and Docker Compose prerequisites were checked or reported as blockers.
• Spring Initializr command used the intended artifactId, bootVersion, dependencies, javaVersion, packageName, packaging, and type.
• springdoc-openapi-starter-webmvc-ui and archunit-junit5 were added to pom.xml.
• SpringDoc, Redis, JPA, and MongoDB properties were added without committing real secrets.
• docker-compose.yaml defines Redis, PostgreSQL, and MongoDB with required ports, passwords, and volumes.
• .gitignore excludes redis_data, postgres_data, and mongo_data.
• ./mvnw clean test was run or the blocker is documented.