RealizeAlpha

This repository implements the Robinhood API to provide an options focused Android and iOS mobile app using the Flutter SDK.

Getting Started

See our docs for use cases and application requirements.

Latest Release

• RealizeAlpha | Apple App Store: TestFlight only, production release coming soon.
• RealizeAlpha | Google Play Store: Internal testing only, production release coming soon.

Build

Dependencies

In order to build and debug locally, you must install the following dependencies:

• Android Studio (includes SDK Manager)
• VS Code
• Flutter SDK (includes Dart SDK)
• Dart & Flutter VS Code extensions

To ensure your installation was successful, run this command:

flutter doctor -v

Once you see a "No issues found!" message, you are ready to start running the application.

Run & Debug

In VS Code, F5 key, the Run icon, or from the Run menu to start debugging. If prompted choose the Flutter configuration.

Android Device

1. Enable USB debugging on your Android device.
2. Plug in your device.
3. Open the command palette (Ctrl+Shift+P) and enter Flutter: Select Device
   Or
   Navigate to the project directory and run the flutter command.

   flutter run

Debugging Notes

Wireless debugging

• On device, open Settings > System > Developer options.
  • Enable USB debugging & Wireless debugging.
• Connect device to computer over USB. Accept pairing notification on device.
• Open Android Studio > Tools > Device Manager and pair device.
• Run these commands to connect wirelessly:

  $ ${HOME}/AppData/Local/Android/Sdk/platform-tools/adb tcpip 5555
  restarting in TCP mode port: 5555
  $ ${HOME}/AppData/Local/Android/Sdk/platform-tools/adb connect 192.168.86.36
  connected to 192.168.86.36:5555

• Unplug device and start debugging.

iOS Device

1. Enable developer on your iOS device.
2. Open Devices and Simulators window in XCode and ensure that your device is paired and connected.
3. Open the command palette (Ctrl+Shift+P) and enter Flutter: Select Device
   Or
   Navigate to the project directory and run the flutter command.

   flutter run --release

Debugging Notes

• For error Exception: Error running pod install, run the following commands:

  rm -rf ./ios/Pods
  rm ./ios/Podfile.lock
  flutter clean
  flutter pub get
  flutter run

Web

Select a browser from the device selector. Note that this is not working due to CORS.

Emulator

Select a mobile emulator from the device selector. Note that this is not working due to ?

Install

Device

1. Connect your Android device to your computer with a USB cable.

2. Navigate to the project directory and run the flutter command.

   flutter install

   The response should contain the following status message.

   Installing app.apk to Pixel 5...
   Uninstalling old version...
   Installing build\app\outputs\flutter-apk\app.apk...                 5.2s

Maintain

Upgrade dependencies

To ensure you are using the latest packages, run these commands to check and upgrade them:

flutter pub outdated
flutter pub upgrade --major-versions
flutter pub upgrade --tighten

Generate App Icons & Launch Images

1. Replace src/robinhood_options_mobile/icon.png with latest icon PNG image at the maximum possible resolution (1024x1024?).
2. Run dart run flutter_launcher_icons in the project directory to generate all icons for iOS and Android.
3. Run dart run flutter_native_splash:create in the project directoru to generate all splash screens for iOS, Android and Web.

Linting (javascript & typescript)

To fix issues with code formatting such as:

10 errors and 0 warnings potentially fixable with the --fix option. Error: functions predeploy error: Command terminated with non-zero exit code 1

Run the following command in the functions directory.

npm run lint -- --fix

You can do this automatically in VS Code by installing the eslint plugin.

Publish

Firebase Hosting

firebase.json was changed to modify the hosting property "source": "." to "public": "build/web" in order to deploy custom builds.

#flutter build web --web-renderer html
flutter build web
firebase deploy --only hosting

Previously, the public folder was deployed with this configuration:

{
  "hosting": {
    "public": "public",
    "ignore": [
      "firebase.json",
      "**/.*",
      "**/node_modules/**"
    ],
    "rewrites": [
      {
        "source": "**",
        "destination": "/index.html"
      }
    ]
  }
}

Firebase Functions

Functions will automatically deploy with hosting deployments with firebase deploy. To deploy only the functions, use the following command.

firebase deploy --only functions

Android Play Store

Build app bundle

flutter build appbundle --release

Generate APKs

This command generates an .apk file used to publish an installation file.

flutter build apk --release

Apple App Store

Build IPA

flutter build ipa --release

If you get an error, see Debugging Notes section above to clean the project.

Upload to App Store

1. Install Transporter App
2. Add ipa file from ./build/ios/ipa/
3. Verify and Deliver

Test

flutter test