Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.7 KB
Raw

Welcome to Courier Flutter contributing guide

Getting Started

  1. From root, run: flutter pub get
  2. Navigate to example/lib
  3. Create a env.dart file and create a class named Env
  4. Copy content from env.sample.dart and paste in env.dart
  5. Drag and drop your google-services.json file into example/android/android/app (Needed for Firebase FCM testing)
  6. Navigate to example/ios, double click on Runner.xcworkspace
  7. Select Runner in xcode click on add files to "Runner" and add GoogleService-Info.plist

From here, you are all set to start working on the package! 🙌

Testing, Debugging & Release

To make package changes there are 3 areas to keep in mind:

  1. The plugin code itself lives in lib. This code is used to interface with the native sides of the SDK
  2. android contains all flutter specific android code
  3. ios contains all flutter specific ios code

The Flutter SDK, for the most part, simply depends on changes made to the base level iOS and Android SDKs.

If you make a change to a base level SDK and want it to be reflected in the Flutter SDK.

  1. Update the ios/courier_flutter.podspec Courier-iOS dependency to reflect the latest base SDK version
  2. Update the android/build.gradle com.github.trycourier:courier-android:xxx dependency to reflect the latest base SDK version
  3. If ready for release, be sure to test the app on a device and then run sh release.sh from root

To run automated tests:

  1. Run test/courier_flutter_test.dart

To release a new build of the SDK:

  1. Change the pubspec.yaml version to the version you want to release
  2. Run sh release.sh from root
    • Required access to create builds in Github with Github CLI
    • Will push new release to pub.dev