Recco Android SDK

This repository holds the codebase for the Recco Android SDK. Instructions on how to add and use this Android library can be found in the Usage section.

Demo

Would you like to experience the Showcase application directly in your device?

Go ahead! Feel free to install it using the following download link. Alternatively, you are welcome to clone this repository and launch the project yourself. To be able to do that, please add to the top level local.properties the following variables:

recco.base.url="https://recco-api.significo.app/"
recco.client.secret="API_KEY"

To obtain a tester API key, please send an email to recco@significo.com. If you wish to integrate it into your application, you must first begin the license acquisition process by contacting our support team. For this, also email recco@significo.com.

Overview

Personalized, and user-friendly approach to health and wellness recommendations based on users' unique interests, motivations, and health behaviors. Whether they are looking to improve their fitness, manage their stress, or simply lead a more fulfilling life. Recco is designed to help them reach their full potential.

We believe that everyone deserves to live their best life, and we are committed to making that vision a reality through our cutting-edge technology and unwavering dedication to scientific accuracy.

Mission

Allow experiencing firsthand the effectiveness of our recommendation engine. Empower users to achieve their best selves through personalized recommendations that are grounded in the latest scientific research.

Enabling products to provide their users with a wealth of knowledge, tips, and exercises to help them improve their behavior and achieve their goals.

Key features

Keeping it simple

We believe in open communication and encourage individuals to take ownership and responsibility for their actions. We reject the notion of blame culture and instead embrace collaboration, recognizing that we are stronger together. Let us extend a helping hand to one another as we work towards achieving our common goals.

Seamless integration

This product has a special focus on working smoothly with existing products. With very few steps Recco can be configured and fully operational.

Technological trend

Recco aims to be in line with modern solutions and development trends, best practices and official guidelines are followed to keep quality at is highest level.

Analytics & Reporting

Monitor the utilization and impact of the recommendation engine. You can track key metrics like user engagement, satisfaction levels, and health outcomes to evaluate the effectiveness of our solution.

Personalized content

Our engine learns to recommend the user content for each topic that the user motivate to improve their health behavior. The recommendations will change on the path of the user and will recommend always the content which the user helps to go forward in the specific time.

Setup

Recco can be integrated and be part of your product the whole product experience, is brought in the shape of a a full user interactive journey having all features included.

Following this approach, integration brings access to services in which the UI solution leans, so consumers can develop their own experiences.

To be able to work with Recco, some artifacts are needed to be downloaded, to do so:

• Github Packages configuration is needed. Check Personal Access Token section in order to provide a set of valid credentials.

• Configure your gradle.properties file under ~/.gradle/ folder

gprUser=your-github-user-here
gprKey=your-github-key-here

• In order to sync artifacts previously published in Github Packages repository, you need to add the following configuration. Inside settings.gradle.kt file.

repositories {
  ...
  maven {
    name = "GithubPackages"
    url = uri("https://maven.pkg.github.com/SignificoHealth/recco-android-sdk")
    credentials {
      username = extra["gprUser"].toString()
      password = extra["gprKey"].toString()
    }
  }
}

Then, include the dependency in your module level build.gradle file and sync again.

  // UI 
  implementation("com.significo:recco-api-ui:<release-version>")

Releases

Our CHANGELOG.md contains all releases information.

All artifacts are available in Github.

Usage

This section aims to explain how Recco integration in Android projects is accomplished. Make sure, you also check out Flutter and iOS counterparts !

You will find a more detailed implementation example and a full UI journey explanation in the Showcase document.

Api summary

Method	Description
init	Configures Recco given an application name and and clientSecret.
login	Performs login operation given a user identifier.
logout	Performs logout operation.
navigateToDashboard	Launches Recco's full experience journey.

init

Param	Type	Optional	Description
sdkConfig	ReccoConfig	NO	Recco configuration object made from an application name, secret key and a style.
application	Application	NO	Android application context.
logger	ReccoLogger	YES	Allows configuring a logger instance to trigger debug and error log ops.

// Annotate your Application entry point using Hilt
@HiltAndroidApp
class YourApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        //...
        //...

        ReccoApiUI.init(
            // SDK Config
            sdkConfig = ReccoConfig(
                clientSecret = "CLIENT SECRET HERE",
                style = ReccoStyle()
            ),

            application = this,

            // This is a logger implementation example, you can provide your own !
            logger = DefaultReccoLogger()
        )
    }
}

As part of the ReccoConfig setup, you have the option to supply an optional ReccoStyle instance to configure some customization entry points:

• ReccoFont: This defines the set of available predefined fonts.
• ReccoPalette: This defines the set of available predefined color palettes, including a custom palette that allows you to provide a personalized selection of colors.

Please, take a look on the Recco Showcase application documentation so you can get more information on Recco Styles.

Bonus: How to provide your own ReccoLogger implementation ?

object : ReccoLogger {
    override fun e(e: Throwable, tag: String?, message: String?) {
        // Your error logging operation here
    }

    override fun d(message: String, tag: String?) {
        // Your debug logging operation here
    }
}

login

Param	Type	Optional	Description
userId	String	NO	User to be consuming the SDK and to be creating its own experience.

// Button OnClick action login implementation sample
@Composable private fun login() {

    Button( // Button config here ),
        // ...

        onClick = {

            ReccoApiUI.login(userId = textField)

            // Useful point to store user data
        }
    ) {
        Text(text = "Login")
    }
}

logout

// Button OnClick action logout implementation sample
@Composable private fun logout() {

    Button( // Button config here ),
        // ...

        onClick = {

            ReccoApiUI.logout()

            // Useful point to clear stored data if any
        }
    ) {
        Text(text = "Logout")
    }
}

navigateToDashboard

Param	Type	Optional	Description
context	Context	NO	Android context.

// Button OnClick action navigateToDashboard implementation sample
@Composable private fun openReccoExperience() {

    Button( // Button config here ),
        // ...

        onClick = {

            ReccoApiUI.navigateToDashboard(this@MyActivity)
        }
    ) {
        Text(text = "Open Recco")
    }
}