Skip to content

Beiwe is a smartphone-based digital phenotyping research platform. This is the Beiwe Android app code. The Beiwe2 app is also available on the Google Play store to use with open source builds of the Beiwe backend.

License

Notifications You must be signed in to change notification settings

genadytr/beiwe-android

 
 

Repository files navigation

Compiling and running the Beiwe Android app

Compiling

To compile and sign the app, you must add a directory called private (beiwe-android's .gitignore file keeps the private directory out of Git), and a file called private/keystore.properties, with these lines (no quotes around the values that you fill in):

storePassword=KEYSTORE_PASSWORD
keyPassword=KEY_PASSWORD
keyAlias=KEY_ALIAS
storeFile=KEYSTORE_FILEPATH

You can also configure a Sentry DSN for each build type in this file.

releaseDSN=https://publicKey:secretKey@host:port/1?options
betaDSN=https://publicKey:secretKey@host:port/1?options
developmentDSN=https://publicKey:secretKey@host:port/1?options

Build Variants and Product Flavors

There are three Build Variants and three Product Flavors of the Android app, specified in the buildTypes section of app/build.gradle. To select which Build Variant the app compiles as, go to Build > Select Build Variant in the menu bar (see the documentation).

The three Build Variants are:

  • release- Does NOT have the Debug Interface. The app is named "Beiwe" when installed on the phone.

  • beta- DOES have the Debug Interface, and allows passwords as short as 1 character. The app is named "Beiwe-beta" when installed on the phone.

  • development- DOES have the Debug Interface, and allows passwords as short as 1 character. The Debug Interface also has some extra buttons that are only useful for developers, like buttons to crash the app. Also includes some extra logging statements (that are printed to Android Monitor if the phone is plugged into a debugger, but are not printed to Beiwe log files). The app is named "Beiwe-development" when installed on the phone.

The three Product Flavors are:

  • onnelaLabServer- Does NOT allow the participant to specify the study server URL at registration (release points to studies.beiwe.org, while beta and development point to staging.beiwe.org). DOES record text message and call log statistics.

  • googlePlayStore- DOES allow the participant to specify the study server URL at registration. Does NOT record text message and phone call statistics.

  • commStatsCustomUrl- DOES allow the participant to specify the study server URL at registration. DOES record text message and phone call statistics.

About

Beiwe is a smartphone-based digital phenotyping research platform. This is the Beiwe Android app code. The Beiwe2 app is also available on the Google Play store to use with open source builds of the Beiwe backend.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%