The Blue Alliance - iOS App

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

Setup

Install Build Tool Dependencies

The Blue Alliance for iOS has a few build tool dependencies. Here's how to install those, if you need them. The commands below suggest Homebrew to install the dependencies. If you're on Windows or Linux, follow the links to find platform-specific setup instructions.

1. Install Xcode
   • The Blue Alliance for iOS is written in Swift 4.1, which comes with Xcode 9.3+
2. Install Ruby (if it's not already installed on your system) and Bundler
   • brew install ruby
   • gem install bundler
3. Install Node/npm
   • brew install node

Install Project Dependencies

These should be done after you've cloned the project and navigated to the project directory

1. Install React Native dependencies
   • cd subtrees/the-blue-alliance-react && npm install && cd ../..
2. Install Ruby dependencies
   • bundle install
3. Install Cocoapods dependencies
   • bundle exec pod install --repo-update

Setup Firebase

The Blue Alliance's mobile apps depend on Firebase. We configure Firebase in The Blue Alliance for iOS using a GoogleService-Info.plist file, provided by Firebase. The production plist isn't checked in to source control, since it contains an API key. You can setup your own Firebase application to develop against.

1. Navigate to the Firebase Console
2. Click Add Project
3. Enter a project name to work with - preferrably something namespaced to yourself (ex: zach-tba-dev)
4. After your project is done setting up, click your newly created project
5. On the landing page, click Add Firebase to your iOS app
6. Enter a locally namespaced bundle identifier (ex: com.the-blue-alliance.zach-tba-dev)
7. Click Register App
8. Download the GoogleService-Info.plist

Building in Xcode

Before bulding in Xcode, make sure you've setup a Firebase project, as described in the Setup Firebase section

1. Be sure you have all required build tools, as described in the Install Build Tool Dependencies section
2. Install project dependencies, as described in the Install Project Dependencies section
3. Open the workspace file (the-blue-alliance-ios.xcworkspace)
4. Modify your bundle identifier to the same bundle identifier you used during your Firebase setup
   • Click the-blue-alliance-ios project in the left sidebar in Xcode
   • On the left sidebar, under Targets click The Blue Alliance
   • Click the General tab along the top bar
   • Change Bundle Identifier to the bundle identifier you set during Firebase setup
5. Add your GoogleService-Info.plist is in the the-blue-alliance-ios/the-blue-alliance-ios folder. If linked properly, the GoogleService-Info.plist file in the Xcode project navigation should go from being red to being black
6. Build and run The Blue Alliance for iOS!

Contributing

Want to add features, fix bugs, or just poke around the code? No problem!

Project Communication

• Keep up to date with the mailing list.
• Chat with us on our Slack team. (Request an invite in the mailing list.)

iOS discussion happens in the #dev-ios channel in the Slack

Learning

Future information on project structure, classes, etc. coming later

Finding Tasks

Outstanding work for The Blue Alliance for iOS is tracked in GitHub Issues. All Issues are tagged with labels. Issues have a priority (high priority, low priority, nice to have) and a type (bug, enhancement), as well as some additional information (feature parity, good first issue, TBAKit, etc).

If you're new to The Blue Alliance for iOS, the good first issue label is a great place to start!

Make Commits!

1. Fork this repository and follow setup setups
2. Make, commit, and push your changes to your branch
3. 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.

Miscellaneous

This is the junk drawer of sections. If you're looking for information not covered above, it might be here. Eventually, this information will move to the Wiki.

Working with React Native

Instructions for installing, building, and debugging/running locally the React Native code can be found in the-blue-alliance-react repo. Execute these commands while in the subtrees/the-blue-alliance-react folder

If you make changes to the React Native code and want to push them upstream, you can do this locally from this repo

1. Add your forked project remote
   • git remote add <REMOTE NAME> <YOUR FORK URL>
   • Example: git remote add zach-the-blue-alliance-react https://github.com/ZachOrr/the-blue-alliance-react.git
2. Push your changes to your forked repo
   • git subtree push --prefix=subtrees/the-blue-alliance-react <REMOTE NAME> <REMOTE BRANCH>
   • Example: git subtree push --prefix=subtrees/the-blue-alliance-react zach-the-blue-alliance-react master
3. Open a Pull Request against the-blue-alliance-react repo!

myTBA Debug Setup

Debug builds of the TBA app cannot receive (Firebase 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.