Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-blue-alliance/the-blue-alliance-android
An Android app for accessing information about the FIRST Robotics Competition.
https://github.com/the-blue-alliance/the-blue-alliance-android
android android-app first-frc first-robotics-competition firstrobotics frc robotics-competition the-blue-alliance
Last synced: 5 days ago
JSON representation
An Android app for accessing information about the FIRST Robotics Competition.
- Host: GitHub
- URL: https://github.com/the-blue-alliance/the-blue-alliance-android
- Owner: the-blue-alliance
- License: mit
- Created: 2014-04-20T22:06:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T20:54:54.000Z (21 days ago)
- Last Synced: 2024-12-22T08:08:18.996Z (12 days ago)
- Topics: android, android-app, first-frc, first-robotics-competition, firstrobotics, frc, robotics-competition, the-blue-alliance
- Language: Java
- Size: 86.2 MB
- Stars: 78
- Watchers: 15
- Forks: 35
- Open Issues: 89
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
The Blue Alliance - Android App
===============================
 [](https://coveralls.io/r/the-blue-alliance/the-blue-alliance-android) [
](https://github.com/the-blue-alliance/the-blue-alliance-android/labels/ready) [](https://github.com/the-blue-alliance/the-blue-alliance-android/labels/needs-review) [](https://github.com/the-blue-alliance/the-blue-alliance-android/labels/on-hold)
An Android app for accessing information about the FIRST Robotics Competition. This is a native mobile version of [The Blue Alliance](http://www.thebluealliance.com).
The app has been released to the [Play Store](https://play.google.com/store/apps/details?id=com.thebluealliance.androidclient&hl=en)! We also have a [beta tester community](https://plus.google.com/communities/108444518980185742549) that you can join to try some of the latest and greatest features without having to build the app yourself. Just remember, there may still be issues. If you find any, please report them on the issue tracker so we can fix them.
Contributing
============
Want to add features, fix bugs, or just poke around the code? No problem!
### Project Management
- Keep up to date with the [mailing list](https://groups.google.com/forum/#!forum/thebluealliance-developers).
- Read through the [planning documents](https://drive.google.com/#folders/0B5RO2Yzh2z01MDBOVXYwM1lXdFk) so you know what's going on.
- Chat with us on our [Slack team](https://the-blue-alliance.slack.com/). (Request an invite in the mailing list.)
### Learning
- Read through the [Project Wiki](https://github.com/the-blue-alliance/the-blue-alliance-android/wiki) to get comfortable with some of the technologies we use.
- Learn some basics of [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection), specifically [Dagger2](http://google.github.io/dagger/), to understand one of the core components of our app.
### Make Commits!
1. Set up your development environment if you haven't used Android Studio before ([see below](#setup)).
2. Fork this repository, import the project to your IDE, and create a branch for your changes.
3. Make, commit, and push your changes to your branch.
4. Submit a pull request here and we'll review it and get it added in!
For more detailed instructions, see [GitHub's Guide to Contributing](https://guides.github.com/activities/contributing-to-open-source/).
We use the base [Android Code Style](https://github.com/android/platform_development/blob/master/ide/intellij/codestyles/AndroidStyle.xml).
When you set up Android Studio, copy `AndroidStyle.xml` into your config directory,
* on Linux: `~/.AndroidStudioXX/config/codestyles/`
* on OSX: `~/Library/Preferences/AndroidStudioXX/codestyles/`
Then start Android Studio, open Settings -> Editor -> Code Style, and in the
dropdown, select `AndroidStyle`.
###
Environment Setup
-----------------
1. Ensure that you have git installed and that it is added to your system's `PATH` variable. You should be able to open your system's shell, navigate to a git repository (like this one), run ```git status```, and get status info.
2. If you haven't already, make sure you have the Android development environment set up. You will need [Android Studio](https://developer.android.com/sdk/installing/studio.html) and a [JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
3. See [Tips and Tricks](https://developer.android.com/sdk/installing/studio-tips.html) for developing with Android Studio.
4. Use the [Android SDK Manager](https://developer.android.com/tools/help/sdk-manager.html) to download the correct versions of the Android SDK Platform, Android SDK Build-Tools, Android SDK Platform-Tools, Android SDK Tools, Android Support Library, Android Support Repository, and Google Repository. See `build.gradle` and `android/build.gradle` for the currently needed versions. While you're downloading, the Documentation for Android SDK and the SDK Platform Sources are also useful.
5. If you have an Android device to test on, make sure to [enable USB Debugging](http://stackoverflow.com/questions/16707137/how-to-find-and-turn-on-usb-debugging-mode-on-nexus-4) in its Settings menu.
6. [Configure an Android Virtual Device (AVD)](https://developer.android.com/tools/devices/managing-avds.html) to debug with. You'll have to download an Android System image via the SDK manager. Android x86-based System images run much faster than ARM-based System images but they require [Virtual Machine Acceleration](http://developer.android.com/tools/devices/emulator.html#accel-vm). Note that the SDK manager will install the Intel HAXM _installer_ on your local disk. You might have to run that installer, depending on your development OS.
7. Set up a Firebase project for login authentication and remote configuration:
1. Open the [Firebase console](https://console.firebase.google.com/).
1. Create a Firebase project. If you have a TBA dev web site AppEngine project, you can use that project to link them together. That ought to prove useful but it's not required. If not, you could name the new one something like "_YOURNAME_-tba-dev".
1. Click "Add Firebase to your Android app".
1. Enter the package name `com.thebluealliance.androidclient.development` into the form.
1. Follow [these instructions](https://developers.google.com/android/guides/client-auth) to determine your debug SHA1. Enter that into the form.
1. Continue. It should download a `google-services.json` file.
1. Move the downloaded `google-services.json` file into `android/src/debug/`. ***Note:*** _Don't_ put it in the directory shown in the "Add Firebase to your Android app" instructions.
1. Use the [TBA Account Overview page](https://www.thebluealliance.com/account) to create an APIv3 "Read API Key" auth key.
1. In the [Firebase console](https://console.firebase.google.com/), create a Remote Config,
1. then add this parameter: `apiv3_auth_key` = _<your TBA v3 auth key>_,
1. and add this parameter: `appspot_projectId` = _<your Firebase project name>_,
1. then click `PUBLISH CHANGES`.
1. You should now be able to build and run the app. If you have FirebaseCrash in use, it'll throw an exception in app init if the `google-services.json` file is invalid.
8. To run the unit tests, do `./gradlew test`
###
myTBA Debug Setup
------------------
Debug builds of the TBA app cannot receive (Google Cloud Messaging) push notifications from production TBA servers. To test the myTBA features of the app, e.g. to test push notifications end-to-end, you must set up a debug [TBA server](https://github.com/the-blue-alliance/the-blue-alliance) then configure the server and temporarily modify the app code. For help setting up your own development server to test myTBA with, see [this wiki page](https://github.com/the-blue-alliance/the-blue-alliance-android/wiki/myTBA-Configuration).
But you don't need to do all that to test the app's local handling of push notifications. The easy way is to run `scripts/test_notification.py`. It uses adb to send notification Intents locally.