Getting Started

Add this in settings.gradle.kts:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven ("https://jitpack.io")
    }
}

Now add the dependency in build.gradle.kts:

dependencies {
    implementation("com.github.klerk-framework:<version>")
}

Make sure you have configured the project to use Java 17 or later.

Now what?

When developing a system using Klerk, we must:

1. Build a configuration: This is where you declare all rules.

val config = ConfigBuilder<Ctx, Data>(collections).build {
    // lots of stuff here
}

2. Start Klerk

val klerk = Klerk.create(config)
klerk.meta.start()

3. Use Klerk: Read data and issue commands to modify data.

val myBook = klerk.read(context) { get(myBookId) }