From 1d31d8743ae58696c2174a9f9d1cda0981790076 Mon Sep 17 00:00:00 2001 From: Piotr Potulski Date: Sun, 30 Aug 2020 20:46:02 +0200 Subject: [PATCH] Update instructions for running the project from the scratch (#837) * Update instructions for running the project from the scratch * Update README.md Co-authored-by: Justin Bassett Co-authored-by: Justin Bassett --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ec760d457..3c6886fd1 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,28 @@ If you are looking for documentation around the companion applications check out - Create a Firebase project at [Firebase Console](https://console.firebase.google.com) -- Create two Android apps, one with `io.homeassistant.companion.android` and one with `io.homeassistant.companion.android.debug` as package name +- Create four Android apps, with following package names + - `io.homeassistant.companion.android` + - `io.homeassistant.companion.android.debug` + - `io.homeassistant.companion.android.minimal` + - `io.homeassistant.companion.android.minimal.debug` -- Now download the `google-services.json` file and put it in the _home-assistant-Android/app_ folder +- Now download the `google-services.json` file and put it in the _home-assistant-Android/app_ folder. This file contains the configuration of the whole project (all the four applications). [You can also use the mock services file instead of generating your own](/.github/mock-google-services.json) - The file should contain client IDs for `io.homeassistant.companion.android` and `io.homeassistant.companion.android.debug` for debugging to work properly. **If you do not generate your own file push notification will never work** + The file should contain client IDs for all packages listed above for debugging to work properly. **If you do not generate your own file push notification will never work** - Start Android Studio, open your source code folder and check if the Gradle build will be successful +- Create keystore containing keypair for debug application signing. In Android Studio: Menu/Build/Generate signed APK, then use a button to create new keystore. Remember the passwords and key alias + +- Set environmental variables used in `app/build.gradle.kts`: + - `KEYSTORE_PASSWORD` + - `KEYSTORE_ALIAS` + - `KEYSTORE_ALIAS_PASSWORD` + +- Run the build using `gradlew build` from command line. + - If the build is successful, you can run the app by doing the following: click **Run** -> **Run 'app'** - Connect your phone or create a new virtual device following on screen instruction