Skip to content

Setup

Jump to bottom
Zachary Orr edited this page Apr 24, 2022 · 20 revisions

To develop for The Blue Alliance for iOS, you will need a machine running macOS.

Install Build Tool Dependencies

The commands below suggest Homebrew to install the dependencies.

  1. Install Xcode
    • The Blue Alliance for iOS is written in Swift 5.5/Xcode 13.2.1
  2. Install the Xcode command line tools
    • xcode-select --install
    • Or, open Xcode, go to Preferences -> Locations -> Command Line Tools, and select your version of Xcode
  3. Install Ruby 2.7.3 (if it's not already installed on your system) and Bundler

Install Project Dependencies

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

$ bundle install

Setup TBA API

The Blue Alliance's mobile apps depend on The Blue Alliance's API for providing data. You'll need an API key to develop with when testing/building.

  1. Navigate to The Blue Alliance's Account page (sign in if prompted)
  2. Scroll down to Read API Keys
  3. Enter a locally namespaced description (ex: zach-tba-ios-dev)
  4. Click + Add New Key to generate a new API key

We'll use this key in the Setup Secrets step when setting up local secrets in the The Blue Alliance for iOS project.

Setup Secrets

The Blue Alliance for iOS stores secrets locally in a Secrets.plist file, which is loaded dynamically at runtime as a dictionary to be used in the app. Create a Secrets.plist file from the template mock-Secrets.plist

$ cp mock-Secrets.plist the-blue-alliance-ios/Secrets.plist

If linked properly, the Secrets.plist file in the Xcode project navigation should go from being red to being black. Edit Secrets.plist (either in Xcode or in a text editor) and fill out the secret values. tba_api_key should be the TBA API key you generated in the Setup TBA API step.

Building in Xcode

  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. Setup your Secrets.plist file, as described in the Setup Secrets section
  4. Open the workspace file (the-blue-alliance-ios.xcworkspace)
  5. Build and run The Blue Alliance for iOS!

Updating Your Environment

If you have a local copy of the repo but haven't work on it in a while, updating to the latest codebase is fairly straightforward

$ git pull
$ bundle install
Clone this wiki locally