Data4Life Data Donation SDK

A crossplatfrom SDK for Data-Donation on Android and iOS

Explore the docs »

Report Bug · Request Feature

Table Of Contents

• About The Project
  • Dependencies
• Installation
  • Consume GitHub Packages
• Building and Working with the SDK
  • Requirements
  • Built With
• Roadmap
• Changelog
• Versioning
• Contributing
• Copyright and License

About The Project

This is the Android and iOS DataDonation-SDK of Data4Life.The SDK encapsulates the backend functionality of the Data4Life Analytics Platform (ALP) and enables end-to-end encryption for donating health data. For more information about the platform, visit our website www.d4l.io.

Dependencies

The SDK has the following dependencies:

• slf4j (Android only)

• Kotlin Coroutines

• Ktor

• Kotlin Serialization

• Koin

• kotlinx-datetime

• Stately Common

• Stately Isolate

• D4L-FHIR-SDK-KMP

• D4L-Util-SDK-KMP

• D4L-ObjC-Util-SDK-KMP

• D4L-Coroutine-Util-SDK-KMP

• D4L-Result-SDK-KMP

Installation

Consume GitHub Packages

We use GitHub Packages to distribute the SDK. In order to consume our dependencies you need to generate a GitHub Personal Access Token. Please follow the how to authenticate to GitHub Packages.

NOTICE

You need to have read access to this repository and generate a personal access token with repo and read:packages scope.

Token

The token needs to be made available.

1. Add gpr.user = {GitHub username} and gpr.key = {GitHub Personal Access Token} to your global Gradle properties ~/.gradle/gradle.properties

   gpr.user=github-username
   gpr.key=github-token

2. Or add following environment variables PACKAGE_REGISTRY_USERNAME={GitHub username} and PACKAGE_REGISTRY_TOKEN={GitHub Personal Access Token}

Setup Maven Repository

Add the following maven repository configuration to your root build.gradle:

    allprojects {
        repositories {
            ...
            maven {
                url = uri("https://maven.pkg.github.com/d4l-data4life/hc-util-sdk-kmp")
                credentials {
                    username = project.findProperty("gpr.user") as String? ?: System.getenv("PACKAGE_REGISTRY_USERNAME")
                    password = project.findProperty("gpr.key") as String? ?: System.getenv("PACKAGE_REGISTRY_TOKEN")
                }
            }
        }
    }

Common

Will be added soon.

Android

Will be added soon.

iOS

Will be added soon.

Building and Working with the SDK

There are several requirements for building the SDK.

Requirements

• Android 6.0 (API 23) to Android 11 (API 30)

• Kotlin 1.4.32

• Java 8 Limitations Desugaring

• Gradle 6.8.3

• Android Studio 4.2.2

• Android Emulator 23 - 30

For the iOS example app is also required:

• Xcode 12.5+

Built With

• Kotlin Multiplatform

Roadmap

Will be added soon.

Changelog

See changelog

Versioning

We use Semantic Versioning as a guideline for our versioning.

Releases use this format: {major}.{minor}.{patch}

• Breaking changes bump {major} and reset {minor} & {patch}

• Backward compatible changes bump {minor} and reset {patch}

• Bug fixes bump {patch}

Contributing

You want to help or share a proposal? You have a specific problem? Read the following:

• Code of conduct for details on our code of conduct.

• Contributing for details about how to report bugs and propose features.

• Developing for details about our development process and how to build and test the project.

Copyright and License

Copyright (c) 2021 D4L data4life gGmbH / All rights reserved.

Please refer to our License for further details.