Skip to content
This repository has been archived by the owner on Jul 19, 2021. It is now read-only.

On Boarding

Jump to bottom
Oliver Spryn edited this page Jun 6, 2019 · 1 revision

For those who have built and run Android projects in the past, setting up the Branham Player for Android is a very familiar and straightforward process. This document guides a new engineer through the steps to build and run the project.

Obtain the Source Files

This project uses Git as its source control tool of choice. Please install this tool on the development machine before continuing.

  1. Clone the project from the repository:

    git clone [email protected]:branham-player/android.git

  2. Open the project's root folder in Android Studio 3.3 or above. As of the time of this writing, 3.3 is not yet generally available and is accessible from the preview page.

Configure Gradle

Secrets, such as API keys, are not checked into GitLab and must be configured separately. These steps show how to set up the build to utilize these secret values.

  1. Create a gradle.properties file at one of the following locations, creating the parent folders, as needed:

    • Windows: C:\Users\<Your Username>\.gradle
    • Mac or Linux: ~/.gradle

  2. Open the Gradle file in a text editor, and add the following line:

    BRANHAM_PLAYER_ANDROID_DEV_LOGGLY_KEY="<API Key>"

  3. Replace the "API Key" with a real key found by logging into the Loggly account > Source Setup > Customer Tokens

  4. Build the project in Android Studio

Configure Firebase

This application uses Google Firebase, but the configuration files are not pushed up to the repository for security purposes.

  1. Go to the Branham Player project in the Firebase Console > Project Settings > General

  2. Download the google-services.json file

  3. Place the file into the base/ folder and the installed/ folder. These are two identical copies of the same JSON file.

Clone this wiki locally