Skip to content

fysiki/workoutkit-android-sdk

Repository files navigation

WorkoutKit Android SDK

This repository includes WorkoutKit packages and a demo app.

TrainingKit migration

WorkoutKit has been renamed to TrainingKit. This repository remains available for existing WorkoutKit integrations, but new integrations should use the TrainingKit package from the new publication repository:

To migrate an existing WorkoutKit integration:

  1. Replace the GitHub Packages Maven URL:
url = uri("https://maven.pkg.github.com/getfizzup/trainingkit-android-sdk")
  1. Replace the dependency:
dependencies {
    implementation 'com.fysiki:trainingkit:<version>'
}
  1. Update imports and public API names:
import com.fysiki.trainingkit.TrainingKit

TrainingKit.initialize(application)
  1. Replace package references from com.fysiki.workoutkit to com.fysiki.trainingkit.

  2. Rebuild your app so generated sources such as Apollo, view binding, and data binding are recreated with the TrainingKit names.

Requirements

WorkoutKit SDK supports Android 5.0 or higher (API level 21).

Installation

1. Add your Github credentials

Add the following two lines to the local.properties file located at the root of your project, replace the placeholders with your Github account's credentials. This step is necessary to download Github packages:

GithubUser=$YOUR_GITHUB_USERNAME
GithubToken=$YOUR_GITHUB_TOKEN

2. Add the Github repository to your build file

Add the following to your allprojects section in the build.gradle file:

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 the dependency

Check the available library packages here.

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

Documentation

  1. 📋 Options


FizzUp WorkoutKit is a complete workout module that can be inserted into your Health App.
To subscribe to FizzUp WorkoutKit contact business@fizzup.com.

About

This repository includes a test application and documentation about how to run WorkoutKit on an Android app.

Resources

License

Stars

5 stars

Watchers

5 watching

Forks

Packages

 
 
 

Contributors

Languages