Kore is the core library of the DavilsX ecosystem, providing essential utilities and abstractions for Kotlin Multiplatform projects.

• Overview
• Core Features
• Quick Start
• Documentation
• Third-Party Software
• Contributing
• License & Ethics

Building Kotlin Multiplatform (KMP) projects requires a solid foundation. Kore provides this foundation by:

• Standardizing Utilities: Common abstractions for UUIDs, platform detection, and value providers.
• Enforcing Ecosystem Consistency: Shared DSL markers and internal annotations used across DavilsX libraries.
• Cross-Platform Reliability: Consistent behavior across JVM, Android, iOS, macOS, Windows, Linux, Wasm, and JS.
• Developer-First Design: Type-safe APIs with explicit API mode enabled for maximum clarity.

Type-safe detection of the underlying system to handle platform-specific logic:

• OS & Architecture: Detect Linux, macOS, Windows, Android, and iOS.
• Environment Context: Identify if the code is running in a browser, JVM, or native environment.
• Type-Safe API: No more magic strings for platform checks.

Full implementation of universally unique identifiers:

• UUID V4: Standard random-based identifiers.
• UUID V7: Time-ordered identifiers for better database performance.
• Multiplatform Support: Native performance on all supported Kotlin targets.

Enforces architectural boundaries and API stability:

• DSL Markers: Centralized @KoreDsl for consistent DSL development.
• API Visibility: @InternalKoreApi and @ExperimentalKoreApi for clear contract communication.
• Compiler Support: Integrated with Kotlin's opt-in requirement system.

Optimized for the modern Kotlin Multiplatform stack:

• Wide Target Support: From mobile (iOS/Android) to web (Wasm/JS) and desktop (JVM/Native).
• Concurrency Ready: Built with coroutines and atomic operations in mind.
• Small Footprint: Minimal dependencies to keep your project lean.

Detailed documentation for Kore is available in the following locations:

• Wiki: The main entry point for guides and documentation.
• Examples: Explore the test suite for reference implementations.

Add the dependency to your Kotlin Multiplatform project's commonMain source set:

kotlin {
    sourceSets {
        commonMain {
            dependencies {
                implementation("com.davils:davilsx-kore:<latest>")
            }
        }
    }
}

Kore is designed to be used as a library. Most features are available out-of-the-box:

import com.davils.kore.uuid.Uuid
import com.davils.kore.system.platform.Platform

// Generate a time-ordered UUID V7
val id = Uuid.randomUuidV7()

// Detect current platform
val os = Platform.current
println("Running on: ${os.name}")

Kore leverages various open-source technologies. For a full list of libraries and licenses, please refer to the Third-Party Software document.

We welcome all contributions! To maintain quality, please note:

• Documentation: Changes to API or behavior must be documented.
• Tests: Ensure your changes are covered by tests.
• Standards: Follow the established Kotlin style and project conventions.

• License: Published under the Apache License 2.0. See LICENSE for details.
• Code of Conduct: We adhere to our Code of Conduct.

Maintained by Davils