Skip to main content

​
Overview

The Encore SDK is distributed as a private Maven package hosted on GitHub Packages. You’ll receive a GitHub Personal Access Token from the Encore Dashboard to authenticate and install the package.

​
Prerequisites: Obtain Access Credentials

Before installing the SDK, you need to obtain your access credentials from the Encore Dashboard.
Don’t have credentials? Visit dashboard.encorekit.com to create an account, add your app, and receive your SDK access credentials automatically.
You’ll need the following:
  • Access Token: A GitHub Personal Access Token (starts with ghp_...) provided through the Dashboard
  • API Key: Your public API key (starts with pk_...) for SDK configuration

​
Install via Gradle

​
Step 1: Add the GitHub Packages Repository

Add the Encore Maven repository to your project-level settings.gradle.kts: 
// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.pkg.github.com/EncoreKit/android")
            credentials {
                username = providers.gradleProperty("gpr.user").getOrElse(System.getenv("GITHUB_USERNAME") ?: "")
                password = providers.gradleProperty("gpr.token").getOrElse(System.getenv("GITHUB_TOKEN") ?: "")
            }
        }
    }
}

​
Step 2: Configure Authentication

Add your credentials to ~/.gradle/gradle.properties (create the file if it doesn’t exist): 
gpr.user=YOUR_GITHUB_USERNAME
gpr.token=YOUR_ACCESS_TOKEN
Never commit credentials to source control. Use gradle.properties in your home directory or environment variables for CI/CD.

​
Step 3: Add the Dependency

Add the SDK to your app-level build.gradle.kts: 
// app/build.gradle.kts
dependencies {
    implementation("com.encorekit:encore:1.4.0")
}

​
Step 4: Sync and Verify

Sync your Gradle project, then verify the SDK is available: 
import com.encorekit.encore.Encore
Installation complete!

​
Next Steps

Now that the SDK is installed, continue with the integration: