
create-spring-boot-java-project
✓ Official★ 36,200by github · part of github/awesome-copilot
Generate a Spring Boot 3.4.5 project skeleton with PostgreSQL, Redis, MongoDB, and Docker Compose. Scaffolds a Maven-based Spring Boot project with Java 21, including Lombok, Spring Data JPA, Spring Web, caching, and validation dependencies Pre-configures application.properties with connection details for PostgreSQL, Redis, and MongoDB, plus SpringDoc OpenAPI for API documentation Generates a docker-compose.yaml file with Redis 6, PostgreSQL 17, and MongoDB 8 services, each with persistent...
Generate a Spring Boot 3.4.5 project skeleton with PostgreSQL, Redis, MongoDB, and Docker Compose. Scaffolds a Maven-based Spring Boot project with Java 21, including Lombok, Spring Data JPA, Spring Web, caching, and validation dependencies Pre-configures application.properties with connection details for PostgreSQL, Redis, and MongoDB, plus SpringDoc OpenAPI for API documentation Generates a docker-compose.yaml file with Redis 6, PostgreSQL 17, and MongoDB 8 services, each with persistent...
Inspect the full instructions your agent will receiveExpandCollapse
This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.
by github
Generate a Spring Boot 3.4.5 project skeleton with PostgreSQL, Redis, MongoDB, and Docker Compose. Scaffolds a Maven-based Spring Boot project with Java 21, including Lombok, Spring Data JPA, Spring Web, caching, and validation dependencies Pre-configures application.properties with connection details for PostgreSQL, Redis, and MongoDB, plus SpringDoc OpenAPI for API documentation Generates a docker-compose.yaml file with Redis 6, PostgreSQL 17, and MongoDB 8 services, each with persistent...
npx skills add https://github.com/github/awesome-copilot --skill create-spring-boot-java-project
Download ZIPGitHub36.2k
Create Spring Boot Java project prompt
Please make sure you have the following software installed on your system:
-
Java 21
-
Docker
-
Docker Compose
If you need to custom the project name, please change the artifactId and the packageName in download-spring-boot-project-template
If you need to update the Spring Boot version, please change the bootVersion in download-spring-boot-project-template
Check Java version
- Run following command in terminal and check the version of Java
java -version
Download Spring Boot project template
- Run following command in terminal to download a Spring Boot project template
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
Unzip the downloaded file
- Run following command in terminal to unzip the downloaded file
unzip starter.zip -d ./${input:projectName:demo-java}
Remove the downloaded zip file
- Run following command in terminal to delete the downloaded zip file
rm -f starter.zip
Change directory to the project root
- Run following command in terminal to change directory to the project root
cd ${input:projectName:demo-java}
Add additional dependencies
- Insert
springdoc-openapi-starter-webmvc-uiandarchunit-junit5dependency intopom.xmlfile
org.springdoc
springdoc-openapi-starter-webmvc-ui
2.8.6
com.tngtech.archunit
archunit-junit5
1.2.1
test
Add docker-compose.yaml with Redis, PostgreSQL and MongoDB services
Create docker-compose.yaml at project root and add following services: redis:6, postgresql:17 and mongo:8.
-
redis service should have
-
password
rootroot -
mapping port 6379 to 6379
-
mounting volume
./redis_datato/data -
postgresql service should have
-
password
rootroot -
mapping port 5432 to 5432
-
mounting volume
./postgres_datato/var/lib/postgresql/data -
mongo service should have
-
initdb root username
root -
initdb root password
rootroot -
mapping port 27017 to 27017
-
mounting volume
./mongo_datato/data/db
Add .gitignore file
- Insert
redis_data,postgres_dataandmongo_datadirectories in.gitignorefile
Run Maven test command
- Run maven clean test command to check if the project is working
./mvnw clean test
Run Maven run command (Optional)
- (Optional)
docker-compose up -dto start the services,./mvnw spring-boot:runto run the Spring Boot project,docker-compose rm -sfto stop the services.
Let's do this step by step
npx skills add https://github.com/github/awesome-copilot --skill create-spring-boot-java-projectRun this in your project — your agent picks the skill up automatically.
Add SpringDoc, Redis, JPA and MongoDB configurations
- Insert SpringDoc configurations into
application.propertiesfile
# SpringDoc configurations
springdoc.swagger-ui.doc-expansion=none
springdoc.swagger-ui.operations-sorter=alpha
springdoc.swagger-ui.tags-sorter=alpha
- Insert Redis configurations into
application.propertiesfile
# Redis configurations
spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.password=rootroot
- Insert JPA configurations into
application.propertiesfile
# JPA configurations
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=postgres
spring.datasource.password=rootroot
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
- Insert MongoDB configurations into
application.propertiesfile
# MongoDB configurations
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=root
spring.data.mongodb.password=rootroot
spring.data.mongodb.database=test
No common issues documented yet. If you hit a problem, the repository's GitHub Issues page is the best place to look.