Skip to content

ZeusWPI/hydra-android

Repository files navigation

Hydra (Android) CI

Get it on Google Play Get it on F-Droid

The Android version of the Hydra app, available for Android 5.0 (Lollipop) and up. Available on Google Play, on F-Droid or as a download in the release section (as an APK file).

Contributing

Quickstart

If you don't have Android Studio or Intellij already, download and install it.

  • Clone the repo, i.e. git clone [email protected]:ZeusWPI/hydra-android.git
  • Choose 'Import Project (gradle etc.)'
  • Choose the folder you just cloned
  • Have fun :)

Alternatively, you can checkout the repo directly from within Android Studio or Intellij.

People who use Nix(OS) can use the flake.nix file in the repo for a dev shell. Note that we don't build the app using flakes; it's only used for a dev shell. Additionally, the flake is very flaky, since Android development in Nixpkgs currently isn't the best.

Keys

If you want to use the Google Maps integration, you will need the API keys. You can contact us for more information and to obtain the keys. This is not required to compile and build the app.

After you've obtained the keys, you will need to copy the file app/secrets.properties.example to app/secrets.properties and insert the correct keys.

Build variants

Hydra comes in two build variants: store and open. The store variant is the main variant, and used for the Play Store and is the recommended version for most people. The open variant only uses open-source software (e.g. OpenStreetMaps instead of Google Maps). Since the open variant contains no crash reporting functionality, crashes from that version not accompanied by a stack trace will not be considered.

Useful links

Other repos

  • Main repo - contains the scrapers and APIs for the data and the shared resources
  • iOS - iOS app

Credits

Google Play and the Google Play logo are trademarks of Google Inc.

License

All code is licensed under the MIT license, unless otherwise noted.