CONTRIBUTING.md

Contributing to the project

requirements

Packages:

• dart
• flutter
• fvm >= 3.0.0
• swiftformat
• ktlint
• Xcode >= 15.3 with Swift >= 5.10

dart pub global activate melos
dart pub global activate very_good_cli
dart pub global activate coverde

important commands

# bootstrap the project, install dependencies, and link packages
melos bootstrap

# generate platform code
melos run generate:pigeon

# generate test mocks
melos run generate:mocks

# run tests
melos run test

# run sample app
melos run run:example -- -d sdk     # android
melos run run:example -- -d IPhone  # ios

# setup a clean local environment
./setup_environment.sh

resources

sourcepoint

• sourcepoint ios SDK
• sourcepoint android SDK

tooling

• Flutter
• Flutter documentation
• using melos and very_good_cli
• very good dev
• melos
• example melos + pigeon repo: flutterfire
• example pigeon + swift host and flutter api