Spezi

Kotlin & Android Version of the Stanford Spezi Framework

An Ecosystem of Modules

Spezi is a collection of modules that can be used to build Android applications

Modules

• Design System: Provides a cohesive user interface and user experience components. Read More
• Account: Provides Account management components. Read More
• Onboarding: Provides Onboarding screens for the application. Read More
• Contact: Provides Contact screens. Read More

Continuous Integration and Delivery Setup

Google Play Internal Deployment

First, create a Google Cloud Services Account and corresponding JSON secrets key in accordance to the fastlane supply documentation. Store the JSON representation of the key in a SERVICE_ACCOUNT_JSON_KEY secret available to the GitHub action.

Follow along the Set up your Google APIs console documentation to create a OAuth client ID. Store secrets.xml representation of the key in a SECRETS_XML secret available to the GitHub action.

This is the secrets.xml representation of the key:

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string name="serverClientId" translatable="false">replace-with-actual-id</string>
</resources>

In Firebase, the provider Google must also be added in the project in the Authentication menu item in the Login method tab.

It is recommended to sign your APK before uploading it to the Google Play store. Setup your signing setup as detailed in the Sign your app documentation.

Create a base64 representation of your keystore (base64 -i ./filetokeystore/keystore.jks) and save it in the KEY_STORE secret available to the GitHub action. Save the keystore password and key password in the KEY_PASSWORD secret and save the key alias in the KEY_ALIAS secret, both available to the GitHub action.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.

License

This project is licensed under the MIT License. See Licenses for more information.