Skip to content

Installation

WorkoutKit Android is currently distributed through GitHub Packages.

GitHub package credentials are still required to download the Android SDK package.

1. Add GitHub credentials for package download

In your project local.properties:

properties
GithubUser=$YOUR_GITHUB_USERNAME
GithubToken=$YOUR_GITHUB_TOKEN

Never commit these credentials to version control.

2. Add GitHub Maven repository

In your root build.gradle repositories block:

groovy
allprojects {
    repositories {
        maven {
            val properties = Properties()
            val file = File("local.properties")
            if (file.exists()) {
                properties.load(file.reader())
            }

            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/fysiki/workoutkit-android-sdk")
            credentials {
                username = properties.getProperty("GithubUser")
                password = properties.getProperty("GithubToken")
            }
        }
    }
}

3. Add dependency

groovy
dependencies {
    implementation 'com.fizzup:workoutkit:v19'
}

Check for available package versions on the organization's GitHub Packages page.