home-assistant-android/README.md
Marcio Granzotto Rodrigues 7d7fc0bd6e Code formatting and linter (#73)
* add ktlint to the project

* Auto format and fix linter issues

* Add Quality section to README
2019-12-01 09:05:37 +01:00

1.4 KiB

📱 Home Assistant Companion for Android Build Status

Setup Development Environment

  • Download and install Android Studio

  • Create a Firebase project at Firebase Console

  • Add an Android app to your Firebase project, follow the on screen instruction download the google-services.json to your home-assistant-Android/app folder

  • Use Android Studio open your source code folder and click Run -> Run 'app'

  • Connect your phone or create a new virtual device following on screen instruction

  • 🎉

Continuous Integration

We are using Travis to perform continuous integration both by unit testing and deploying to Firebase App Distribution or Play Store when we add a git tag.

Quality

We are using ktlint as our linter. You can run a check locally on your machine with:

./gradlew ktlintCheck

This commands runs on our CI to check if your PR passes all tests. So we strongly recommend running it before committing.

To run a check with an auto-format:

./gradlew ktlintFormat