Skip to content

Latest commit

 

History

History
67 lines (36 loc) · 2.19 KB

DEV_README.md

File metadata and controls

67 lines (36 loc) · 2.19 KB
Raw

Airship Flutter Development

Dev Environment

  1. Install tools:
  • Android Studio
  • Flutter
  • Android studio flutter plugin

  1. Make sure flutter is in the tool chain

  2. Run flutter doctor to make sure everything is setup

Plugin Development

  1. Open the root of the project in Android Studio

  2. Follow getting started guide to add the airship config and google-services.json to the example project

  3. To edit the iOS plugin, in Android Studio right click ios folder to open the menu and click Flutter -> Open iOS module in Xcode

  4. To edit Android plugin in Android Studio right click android folder to open the menu and click Flutter -> Open Android module in Android Studio

Updating Plugin Version

To update the plugin version, use the update_version script by running the following command at the project root directory:

Replace NEW_VERSION with your semantic version (i.e. 4.0.0):

./scripts/update_version.sh NEW_VERSION

Documentations

To generate the API documentations for flutter, use the docs script by running the following command at the project root directory:

./scripts/docs.sh -g

To upload the API documentations to google cloud, use the docs script by running the following command at the project root directory:

Replace NEW_VERSION with your semantic version (i.e. 4.0.0):

Replace PATH_TO_DOCS with your path to the generated docs version (i.e. doc):

./scripts/docs.sh -u NEW_VERSION PATH_TO_DOCS

Plugin Structure

android android library module ios iOS library module lib plugin's dart implementation example example app

Flutter communicates bidirectionally with the native layer though channels. MethodChannels are used to initiate communication from dart -> native, and EventChannel from native -> dart.

Troubleshooting

Xcode build errors

You may have to build and deploy the plugin from Android Studio before opening it in Xcode. This will trigger all the pod installs.

Android red symbols

If you see red symbols, you probably need to open the Android module in Android studio using the flutter tool outlined above. This will open it up as an Android project instead of flutter.