/kairo-sample

Primary LanguageKotlinApache License 2.0Apache-2.0

kairo-sample

A sample implementation of Kairo.

This sample project has a single Feature called LibraryFeature, which manages a public library.

There are 3 entities:

  • LibraryBook
  • LibraryMember
  • LibraryCard

A library member can have 0 or more library cards.

Project information

Major dependencies

  • Gradle 8.10
  • Kotlin 2.0
  • Java 21
  • Kairo 0.30

Style guide

  • Product terminology: Treat Kairo Features and Servers as proper nouns (the first letter should be capitalized).

See the style guide for more.

Chores

See chores.

Getting started

Run the Server:

KAIRO_CONFIG=local-development ./gradlew kairo-sample:run

Run checks (tests and lint):

./gradlew check

Full build:

./gradlew build

Build and run using Shadow:

./gradlew kairo-sample:shadowJar
KAIRO_CONFIG=local-development java -jar kairo-sample/build/libs/kairo-sample-shadow.jar