KavaRef

Quick Start

Integrate KavaRef into your project.

Project Requirements

The project needs to be created using IntelliJ IDEA or Android Studio and should be a Java or Android project with integrated Kotlin environment dependencies.

Configure Repositories

The dependencies of KavaRef are published in Maven Central and our public repository, you can use the following method to configure repositories.

We recommend using Kotlin DSL as the Gradle build script language and SweetDependencyopen in new window to manage dependencies.

Configure repositories in your project's SweetDependency configuration file.

repositories:
  google:
  maven-central:
  # (Optional) You can add this URL to use our public repository
  # When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
  # For details, please visit: https://github.com/HighCapable/maven-repository
  highcapable-maven-releases:
    url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases

Traditional Method

Configure repositories in your project's build.gradle.kts.

repositories {
    google()
    mavenCentral()
    // (Optional) You can add this URL to use our public repository
    // When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
    // For details, please visit: https://github.com/HighCapable/maven-repository
    maven("https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases")
}

Configure Java Version

Modify the Java version of Kotlin in your project's build.gradle.kts to 17 or above.

Java Project

java {
    sourceCompatibility = JavaVersion.VERSION_17
    targetCompatibility = JavaVersion.VERSION_17
}

kotlin {
    jvmToolchain(17)
}

Android Project

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
}

Functional Overview

The project is divided into multiple modules. You can choose the module you wish to include as a dependency in your project, but be sure to include the kavaref-core module.

Click the corresponding module below to view detailed feature descriptions.

Demo

You can find some samples hereopen in new window to view the corresponding demo projects to better understand how these functions work and quickly select the functions you need.