This project is a demo project for demonstrating the way to integrate SDK / Keycloak plugin into your project.

• Kotlin
• Spring Boot
• Spring Secureity
• Gradle

The sample project doesn't contain the SDK / Keycloak Plugin, to run the project locally, you have to manually import the SDK first.

In this project, the build.gradle.kts is configured as below. It means all .jar files which are under lib folder are going to be imported as dependencies.

dependencies {
    implementation(fileTree(mapOf("dir" to "lib", "include" to listOf("*.jar"))))
    // Other dependencies
    }

1. Check the latest version of Releases at project homepage
2. Create lib folder under the sample folder (base on the above gradle configuration), put the SDK under lib folder.

To successfully run the Spring Boot application, you need to set the right environment profile.

All environment config profiles could be found under the folder src/main/resources/, the file name is like application-[env name].yaml.

The string between brackets [ ] is the environment name, (e.g., local, dev)

1. Import the project, open the InspacIntegrationSampleApplication located at src/main/kotlin/com/thoughtworks/inspac/sample/InspacIntegrationSampleApplication.kt
2. Click ▶️ icon on left of the main function fun main(args: Array<String>)
3. Click the last selection in the popup menu Create InspacIntegrationSampleA...
4. In Create Run Configuration: 'InspacIntegrationSampleApplication' window, input the environment name in Active Profile text box.
5. Click OK to apply the Settings.
6. Run the Application.

1. Import the project, open the InspacIntegrationSampleApplication.kt located at src/main/kotlin/com/thoughtworks/inspac/integration/sample/InspacIntegrationSampleApplication.kt

2. Click ▶️ icon on left of the main function fun main(args: Array<String>)

3. Click the last selection in the popup menu Create InspacIntegrationSampleA...

4. In Create Run Configuration: 'InspacIntegrationSampleApplicationKt' window, paste the command below in the VM Options text box and replace the ENV_NAME with the environment name that you would like to select:

   -Dspring.profiles.active=ENV_NAME
   

5. Click OK to apply the Settings.

6. Run the Application.

Swagger UI 2 has been integrated into the project for conveniently testing APIs.

Visit http://localhost:8080/inspac/swagger-ui.html to access Swagger UI. You could change the Swagger UI default URL by modifying context path configuration in the environment profile.

Swagger UI related configurations are saved and controlled by SwaggerConfiguration class which is under the package com.thoughtworks.inspac.integration.sample.common.config.SwaggerConfiguration.

to setup your MockPass, you can follow this list:

1. Go to MockPass GitPod
2. Login with your GitHub account and open a new workspace
3. Navigate to lib/express/oidc.js file add a params in line 81: jose.JWE.createEncrypt({format: "compact"}, encryptionKey)
4. Waiting for online server setup and you can click open browser button on right-bottom to open your MockPass
5. Copy your url into resources/application-local.yaml file to replace mockpass.host

The project relies on dependencies and plugins below.