import{_ as t,r as l,o as p,c,b as e,d as s,e as n,w as i,a as r}from"./app-mh6GuRj9.js";const d={},u=r('

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.

',4),h={href:"https://www.jetbrains.com/idea",target:"_blank",rel:"noopener noreferrer"},v={href:"https://developer.android.com/studio",target:"_blank",rel:"noopener noreferrer"},m=e("li",null,[e("p",null,"Kotlin 1.9.0+, Gradle 8+, Java 17+")],-1),y=e("h3",{id:"configure-repositories",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-repositories","aria-hidden":"true"},"#"),s(" Configure Repositories")],-1),b=e("p",null,[s("The dependencies of "),e("code",null,"KavaRef"),s(" are published in "),e("strong",null,"Maven Central"),s(" and our public repository, you can use the following method to configure repositories.")],-1),A={href:"https://github.com/HighCapable/SweetDependency",target:"_blank",rel:"noopener noreferrer"},D=r(`

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.

`,15),C=e("h2",{id:"demo",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#demo","aria-hidden":"true"},"#"),s(" Demo")],-1),B={href:"https://github.com/HighCapable/KavaRef/tree/main/samples",target:"_blank",rel:"noopener noreferrer"};function g(f,k){const a=l("ExternalLinkIcon"),o=l("RouterLink");return p(),c("div",null,[u,e("ul",null,[e("li",null,[e("p",null,[s("IntelliJ IDEA (It is recommended to get the latest version from "),e("a",h,[s("here"),n(a)]),s(")")])]),e("li",null,[e("p",null,[s("Android Studio (It is recommended to get the latest version from "),e("a",v,[s("here"),n(a)]),s(")")])]),m]),y,b,e("p",null,[s("We recommend using Kotlin DSL as the Gradle build script language and "),e("a",A,[s("SweetDependency"),n(a)]),s(" to manage dependencies.")]),D,e("ul",null,[e("li",null,[n(o,{to:"/en/library/kavaref-core.html"},{default:i(()=>[s("kavaref-core")]),_:1})]),e("li",null,[n(o,{to:"/en/library/kavaref-extension.html"},{default:i(()=>[s("kavaref-extension")]),_:1})])]),C,e("p",null,[s("You can find some samples "),e("a",B,[s("here"),n(a)]),s(" to view the corresponding demo projects to better understand how these functions work and quickly select the functions you need.")])])}const F=t(d,[["render",g],["__file","quick-start.html.vue"]]);export{F as default};