Kora guides apps (#44)

* Cleanup

* Added Kora guides apps

* Updated README.md

Author: GoodforGod

.github/workflows/test-master.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         java: [ "21" ]
-        type: [ "Examples" ]
+        type: [ "Examples", "Guides" ]
         lang: [ "Java", "Kotlin" ]
         feature: [ "Database", "Client", "Server", "Graalvm", "Kafka", "Other" ]
     name: Pull Request Java ${{ matrix.java }} for ${{ matrix.type }}-${{ matrix.lang }}-${{ matrix.feature }}

.github/workflows/test-pr.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         java: [ "21" ]
-        type: [ "Examples" ]
+        type: [ "Examples", "Guides" ]
         lang: [ "Java", "Kotlin" ]
         feature: [ "Database", "Client", "Server", "Graalvm", "Kafka", "Other" ]
     name: Pull Request Java ${{ matrix.java }} for ${{ matrix.type }}-${{ matrix.lang }}-${{ matrix.feature }}

README.md

@@ -1,36 +1,40 @@
 [![Maven Central](https://img.shields.io/maven-central/v/ru.tinkoff.kora/common.svg)](https://central.sonatype.com/artifact/ru.tinkoff.kora/common)
 [![GitHub Action](https://github.com/kora-projects/kora-examples/workflows/Build%20Master/badge.svg)](https://github.com/kora-projects/kora-examples/actions?query=workflow%3A%22Build%20Master%22++)
 
-# Kora Examples
+# Kora Examples and Guides
 
 В данном репозитории собраны примеры сервисов, использующих различные модули [фреймворка Kora](https://kora-projects.github.io/kora-docs/ru/).
-Каждый Gradle модуль является независимым сервисом. 
+Каждый Gradle модуль является независимым сервисом.
 
-Здесь можно посмотреть на реализации модулей фреймворка Kora на Java и Kotlin языках, протестировать их функционал, 
+Здесь можно посмотреть на реализации модулей фреймворка Kora на Java и Kotlin языках, протестировать их функционал,
 использовать примеры как пособие по начальному погружению в Kora.
 [Хотите знать больше?](https://kora-projects.github.io/kora-docs/ru/)
 
-## Где находятся примеры
+## Структура
 
-- Java: [`examples/java`](examples/java)
-- Kotlin: [`examples/kotlin`](examples/kotlin)
-- GraalVM: [`examples/graalvm`](examples/graalvm)
+- [Examples](examples) - самостоятельные демонстрационные приложения по модулям Kora.
+- [Guides](guides) - приложения-компаньоны для guide-разделов документации.
+- [Java examples](examples/java) и [Kotlin examples](examples/kotlin) - каталоги примеров по языкам.
+- [Java guides](guides/java) и [Kotlin guides](guides/kotlin) - каталоги guide-приложений по языкам.
+- [GraalVM examples](examples/graalvm) - примеры сборки native image.
 
-[Описание](https://kora-projects.github.io/kora-docs/ru/) | [Документация](https://kora-projects.github.io/kora-docs/ru/documentation/general/) | [Ознакомление](https://kora-projects.github.io/kora-docs/ru/examples/hello-world/) 
+[Описание](https://kora-projects.github.io/kora-docs/ru/) | [Документация](https://kora-projects.github.io/kora-docs/ru/documentation/general/) | [Ознакомление](https://kora-projects.github.io/kora-docs/ru/examples/hello-world/)
 
 ---
 
 This repository contains examples of applications using various [Kora framework](https://kora-projects.github.io/kora-docs/en/) modules.
-Each Gradle module is an independent application. 
+Each Gradle module is an independent application.
 
 Here you can look at implementations of Kora framework modules in Java and Kotlin languages, test their functionality,
 use the examples as a guide for initial immersion in Kora.
 [Would you like to know more?](https://kora-projects.github.io/kora-docs/en/)
 
-## Where examples are located
+## Structure
 
-- Java: [`examples/java`](examples/java)
-- Kotlin: [`examples/kotlin`](examples/kotlin)
-- GraalVM: [`examples/graalvm`](examples/graalvm)
+- [Examples](examples) - standalone demonstration applications for Kora modules.
+- [Guides](guides) - companion applications for documentation guides.
+- [Java examples](examples/java) and [Kotlin examples](examples/kotlin) - language-specific example catalogs.
+- [Java guides](guides/java) and [Kotlin guides](guides/kotlin) - language-specific guide application catalogs.
+- [GraalVM examples](examples/graalvm) - native image build examples.
 
 [Home](https://kora-projects.github.io/kora-docs/en/) | [Documentation](https://kora-projects.github.io/kora-docs/en/documentation/general/) | [Hello World](https://kora-projects.github.io/kora-docs/en/examples/hello-world/)

build.gradle

@@ -7,6 +7,7 @@ plugins {
     id "org.graalvm.buildtools.native" version "0.11.5" apply false // or dependsOn fails in graalvm examples
     id "org.jetbrains.kotlin.jvm" version "1.9.25" apply false
     id "org.jetbrains.kotlin.kapt" version "1.9.25" apply false
+    id "com.google.devtools.ksp" version "1.9.25-1.0.20" apply false
 }
 
 group = groupId

examples/README.md

@@ -0,0 +1,31 @@
+# Kora Examples
+
+This directory contains standalone Kora example applications. The examples are broader module demonstrations, while [guides](../guides) contains companion applications for documentation guides.
+
+Examples are split by language and target runtime:
+
+- [Java examples](java)
+- [Kotlin examples](kotlin)
+- [GraalVM examples](graalvm)
+
+Use the language-specific README files for the module catalog and links to Kora documentation.
+
+## Common Commands
+
+List all example projects:
+
+```shell
+./gradlew projects
+```
+
+Compile a single example:
+
+```shell
+./gradlew :examples:java:kora-java-cache-redis:classes
+```
+
+Run tests for a single example:
+
+```shell
+./gradlew :examples:java:kora-java-cache-redis:test
+```

examples/graalvm/kora-java-graalvm-crud-cassandra/src/main/resources/META-INF/native-image/ru.tinkoff.kora.examples/logback/reflect-config.json

@@ -34,7 +34,7 @@ protected void configure() {
         withExposedPorts(8080, 8085);
         withStartupTimeout(Duration.ofSeconds(50));
         withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger(AppContainer.class)));
-        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200));
+        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200).withStartupTimeout(Duration.ofSeconds(20)));
     }
 
     public int getPort() {

examples/graalvm/kora-java-graalvm-crud-cassandra/src/main/resources/META-INF/native-image/ru.tinkoff.kora.examples/logback/resource-config.json

@@ -34,7 +34,7 @@ protected void configure() {
         withExposedPorts(8080, 8085);
         withStartupTimeout(Duration.ofSeconds(50));
         withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger(AppContainer.class)));
-        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200));
+        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200).withStartupTimeout(Duration.ofSeconds(20)));
     }
 
     public int getPort() {

examples/graalvm/kora-java-graalvm-crud-cassandra/src/test/java/ru/tinkoff/kora/example/graalvm/crud/cassandra/AppContainer.java

@@ -34,7 +34,7 @@ protected void configure() {
         withExposedPorts(8080, 8085);
         withStartupTimeout(Duration.ofSeconds(50));
         withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger(AppContainer.class)));
-        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200));
+        waitingFor(Wait.forHttp("/system/readiness").forPort(8085).forStatusCode(200).withStartupTimeout(Duration.ofSeconds(20)));
     }
 
     public int getPort() {