Skip to content

Zero2848/the-blue-alliance-android

 
 

Repository files navigation

The Blue Alliance - Android App

Build Status Coverage Status Stories in Ready Stories in Needs Review Stories in On Hold

An Android app for accessing information about the FIRST Robotics Competition. This is a native mobile version of The Blue Alliance.

The app has been released to the Play Store! We also have a beta tester community that you can join to try some of the latest and greatest features without having to build the app yourself. Just rememver, 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

Make Commits!

  1. Set up your development environment if you haven't used Android Studio before (see below)
  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, checkout GitHub's Guide to Contributing

Environment Setup

  1. Ensure that you have git installed and that it is added to your system's PATH variable. You should be open you system's shell, navigate to a git repository (like this one), run git status and get data back.
  2. If you haven't already, make sure you have the Android development environment set up. You will need to have Android Studio installed (this also required the JDK).
  3. Make sure you read through some Tips and Tricks for developing with Android Studio.
  4. Use the Android SDK Manager to download the correct versions of the Android libraries. You will need to download the Android SDK Tools, Android SDK Platform-Tools, and the SDK Platform for Android. See android/build.gradle for the currently needed versions.
  5. If you have an Android device to test on, make sure to enable USB Debugging in its Settings menu. Otherwise, configure a Virtual Device to debug with. To use a virtual device, 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. Note that the SDK manager will install the Intel HAXM installer on your local disk; you still have to run that installer unless the Android Studio installer does it for you.
  6. If you want to run Unit Tests from your IDE, make sure that you install the Android Studio Unit Test Plugin. You can install this throught Android Studio's plugin manager (instructions)

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 then configure the server and temporarily modify the app code.

For help setting up your own development server to test myTBA with, check out this wiki page

But you don't need to do all that to test the app's local handling of push notifications. The easy way is to use the test_notification.py script. It uses adb to send notification Intents locally.

About

An Android app for accessing information about the FIRST Robotics Competition.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 99.5%
  • Python 0.5%