Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/awakelife93/spring-boot-kotlin-boilerplate

spring boot 3 (kotlin) boilerplate
https://github.com/awakelife93/spring-boot-kotlin-boilerplate

boilerplate flyway gradle h2-database instancio jpa junit5 jwt kotest kotlin logback mockito-kotlin mockk postgresql querydsl redis spring-batch spring-boot spring-security swagger

Last synced: about 2 months ago
JSON representation

spring boot 3 (kotlin) boilerplate

Host: GitHub
URL: https://github.com/awakelife93/spring-boot-kotlin-boilerplate
Owner: awakelife93
Created: 2024-08-24T05:05:58.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-12-15T06:52:15.000Z (2 months ago)
Last Synced: 2024-12-15T07:26:57.786Z (2 months ago)
Topics: boilerplate, flyway, gradle, h2-database, instancio, jpa, junit5, jwt, kotest, kotlin, logback, mockito-kotlin, mockk, postgresql, querydsl, redis, spring-batch, spring-boot, spring-security, swagger
Language: Kotlin
Homepage:
Size: 145 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

### Spring Boot Boilerplate (Kotlin)

### Environment & Skills

- Application
- Kotlin 2.0
- Jdk 21
- Spring boot 3.3.0
- Gradle 8.10
- Spring Security
- Spring Batch
- Springdoc OpenAPI
- Postgresql
- h2 database (PostgreSQL mode) - localhost environment
- Jpa
- QueryDSL
- Redis
- Jwt
- Validation
- Sentry
- LogBack
- Flyway

- Test
- Spring Boot Starter Test
- Spring Security
- Spring Batch
- Junit 5
- Mockito Kotlin
- Kotest
- Mockk
- Instancio
- h2 database (PostgreSQL mode)
- Flyway

- Tools
- Pgadmin

### Project Guide

- common
- domain (post, user, auth)
- security
- spring security + jwt logic
- utils
- resources
- prod, dev, local, common, test, secret-{environment}
- common: Write common variables for the project.
- test: Create the variables needed for your test environment.
- secret-{environment}: auth (jwt, api key), database information

### Description

- cors
- This project used **spring security** rather than WebMvcConfigurer for the cors environment.
- docker-compose
- If you plan to use it, you need to check the environment variables.
- create spring batch metadata table (localhost, development and production environments.)
- Run your ddl script or Please refer
to [github - spring batch ](https://github.com/spring-projects/spring-batch/blob/5.0.x/spring-batch-core/src/main/resources/org/springframework/batch/core/schema-postgresql.sql)
- Since this project uses postgresql, the spring.batch.jdbc.initialize-schema: always option does not work.
- localhost & test environment,
generating [batch-postgresql-metadata-schema.sql](src/main/resources/db/sql/batch-postgresql-metadata-schema.sql).
- [application-test.yml](src/main/resources/application-test.yml)
- two types of tests
- [mockito](src/test/kotlin/com/example/demo/mockito)
- [kotest & mockk](src/test/kotlin/com/example/demo/kotest)
- **if you want to bypass Spring Security authentication issues.**
- [SecurityListerFactory](src/test/kotlin/com/example/demo/kotest/common/security/SecurityListerFactory.kt)
- [BaseIntegrationController](src/test/kotlin/com/example/demo/kotest/common/BaseIntegrationController.kt)
```kotlin
// example

listeners(SecurityListerFactory())

Then("Call DELETE /api/v1/users/{userId}").config(tags = setOf(SecurityListerFactory.NonSecurityOption)) {
// ...
}
```

### Author

Hyunwoo Park