diff --git a/README.md b/README.md index 7d8d766..9d62c3f 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [ASP.NET Minimal API with OpenAPI](prompts/aspnet-minimal-api-openapi.prompt.md) | Create ASP.NET Minimal API endpoints with proper OpenAPI documentation | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faspnet-minimal-api-openapi.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faspnet-minimal-api-openapi.prompt.md) | | [Azure Cost Optimize](prompts/az-cost-optimize.prompt.md) | Analyze Azure resources used in the app (IaC files and/or resources in a target rg) and optimize costs - creating GitHub issues for identified optimizations. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faz-cost-optimize.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faz-cost-optimize.prompt.md) | | [Comment Code Generate A Tutorial](prompts/comment-code-generate-a-tutorial.prompt.md) | Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md) | +| [Create Spring Boot Java project prompt](prompts/create-spring-boot-java-project.prompt.md) | Create Spring Boot Java project skeleton | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-java-project.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-java-project.prompt.md) | +| [Create Spring Boot Kotlin project prompt](prompts/create-spring-boot-kotlin-project.prompt.md) | Create Spring Boot Kotlin project skeleton | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-kotlin-project.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-kotlin-project.prompt.md) | | [C# Async Programming Best Practices](prompts/csharp-async.prompt.md) | Get best practices for C# async programming | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-async.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-async.prompt.md) | | [C# Documentation Best Practices](prompts/csharp-docs.prompt.md) | Ensure that C# types are documented with XML comments and follow best practices for documentation. | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-docs.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-docs.prompt.md) | | [MSTest Best Practices](prompts/csharp-mstest.prompt.md) | Get best practices for MSTest unit testing, including data-driven tests | [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-mstest.prompt.md) [![Install in VS Code](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-mstest.prompt.md) | diff --git a/prompts/create-spring-boot-java-project.prompt.md b/prompts/create-spring-boot-java-project.prompt.md new file mode 100644 index 0000000..9847a85 --- /dev/null +++ b/prompts/create-spring-boot-java-project.prompt.md @@ -0,0 +1,156 @@ +--- +mode: 'agent' +tools: ['changes', 'codebase', 'editFiles', 'findTestFiles', 'problems', 'runCommands', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'testFailure', 'usages'] +description: 'Create Spring Boot Java project skeleton' +--- + +# 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](./create-spring-boot-java-project.prompt.md#download-spring-boot-project-template) + +- If you need to update the Spring Boot version, please change the `bootVersion` in [download-spring-boot-project-template](./create-spring-boot-java-project.prompt.md#download-spring-boot-project-template) + +## Check Java version + +- Run following command in terminal and check the version of Java + +```shell +java -version +``` + +## Download Spring Boot project template + +- Run following command in terminal to download a Spring Boot project template + +```shell +curl https://start.spring.io/starter.zip \ + -d artifactId=demo \ + -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 + +```shell +unzip starter.zip -d . +``` + +## Remove the downloaded zip file + +- Run following command in terminal to delete the downloaded zip file + +```shell +rm -f starter.zip +``` + +## Add additional dependencies + +- Insert `springdoc-openapi-starter-webmvc-ui` and `archunit-junit5` dependency into `pom.xml` file + +```xml + + org.springdoc + springdoc-openapi-starter-webmvc-ui + 2.8.6 + + + com.tngtech.archunit + archunit-junit5 + 1.2.1 + test + +``` + +## Add SpringDoc, Redis, JPA and MongoDB configurations + +- Insert SpringDoc configurations into `application.properties` file + +```properties +# 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.properties` file + +```properties +# Redis configurations +spring.data.redis.host=localhost +spring.data.redis.port=6379 +spring.data.redis.password=rootroot +``` + +- Insert JPA configurations into `application.properties` file + +```properties +# 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.properties` file + +```properties +# 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 +``` + +## 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_data` to `/data` + - postgresql service should have + - password `rootroot` + - mapping port 5432 to 5432 + - mounting volume `./postgres_data` to `/var/lib/postgresql/data` + - mongo service should have + - initdb root username `root` + - initdb root password `rootroot` + - mapping port 27017 to 27017 + - mounting volume `./mongo_data` to `/data/db` + +## Add `.gitignore` file + +- Insert `redis_data`, `postgres_data` and `mongo_data` directories in `.gitignore` file + +## Run Maven test command + +- Run maven clean test command to check if the project is working + +```shell +./mvnw clean test +``` + +## Run Maven run command (Optional) + +- (Optional) `docker-compose up -d` to start the services, `./mvnw spring-boot:run` to run the Spring Boot project, `docker-compose rm -sf` to stop the services. + +## Let's do this step by step diff --git a/prompts/create-spring-boot-kotlin-project.prompt.md b/prompts/create-spring-boot-kotlin-project.prompt.md new file mode 100644 index 0000000..74d16ec --- /dev/null +++ b/prompts/create-spring-boot-kotlin-project.prompt.md @@ -0,0 +1,140 @@ +--- +mode: 'agent' +tools: ['changes', 'codebase', 'editFiles', 'findTestFiles', 'problems', 'runCommands', 'runTests', 'search', 'searchResults', 'terminalLastCommand', 'testFailure', 'usages'] +description: 'Create Spring Boot Kotlin project skeleton' +--- + +# Create Spring Boot Kotlin 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](./create-spring-boot-kotlin-project.prompt.md#download-spring-boot-project-template) + +- If you need to update the Spring Boot version, please change the `bootVersion` in [download-spring-boot-project-template](./create-spring-boot-kotlin-project.prompt.md#download-spring-boot-project-template) + +## Check Java version + +- Run following command in terminal and check the version of Java + +```shell +java -version +``` + +## Download Spring Boot project template + +- Run following command in terminal to download a Spring Boot project template + +```shell +curl https://start.spring.io/starter.zip \ + -d artifactId=demo \ + -d bootVersion=3.4.5 \ + -d dependencies=configuration-processor,webflux,data-r2dbc,postgresql,data-redis-reactive,data-mongodb-reactive,validation,cache,testcontainers \ + -d javaVersion=21 \ + -d language=kotlin \ + -d packageName=com.example \ + -d packaging=jar \ + -d type=gradle-project-kotlin \ + -o starter.zip +``` + +## Unzip the downloaded file + +- Run following command in terminal to unzip the downloaded file + +```shell +unzip starter.zip -d . +``` + +## Remove the downloaded zip file + +- Run following command in terminal to delete the downloaded zip file + +```shell +rm -f starter.zip +``` + +## Add additional dependencies + +- Insert `springdoc-openapi-starter-webmvc-ui` and `archunit-junit5` dependency into `build.gradle.kts` file + +```gradle.kts +dependencies { + implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:2.8.6") + testImplementation("com.tngtech.archunit:archunit-junit5:1.2.1") +} +``` + +- Insert SpringDoc configurations into `application.properties` file + +```properties +# 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.properties` file + +```properties +# Redis configurations +spring.data.redis.host=localhost +spring.data.redis.port=6379 +spring.data.redis.password=rootroot +``` + +- Insert R2DBC configurations into `application.properties` file + +```properties +# R2DBC configurations +spring.r2dbc.url=r2dbc:postgresql://localhost:5432/postgres +spring.r2dbc.username=postgres +spring.r2dbc.password=rootroot + +spring.sql.init.mode=always +spring.sql.init.platform=postgres +spring.sql.init.continue-on-error=true +``` + +- Insert MongoDB configurations into `application.properties` file + +```properties +# 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 +``` + +- 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_data` to `/data` + - postgresql service should have + - password `rootroot` + - mapping port 5432 to 5432 + - mounting volume `./postgres_data` to `/var/lib/postgresql/data` + - mongo service should have + - initdb root username `root` + - initdb root password `rootroot` + - mapping port 27017 to 27017 + - mounting volume `./mongo_data` to `/data/db` + +- Insert `redis_data`, `postgres_data` and `mongo_data` directories in `.gitignore` file + +- Run gradle clean test command to check if the project is working + +```shell +./graldew clean test +``` + +- (Optional) `docker-compose up -d` to start the services, `./graldew spring-boot:run` to run the Spring Boot project, `docker-compose rm -sf` to stop the services. + +Let's do this step by step.