<img align="right" width="112" height="42" title="Breez logo" src="./src/images/logo-color.svg">
c-Breez is a migration of Breez mobile app to the Greenlight infrastructure.
π Read the introduction post
c-Breez depends on Breez sdk-flutter plugin, so be sure to follow those instructions first.
After succesfully having build the sdk-flutter make sure that breez-sdk and c-breez are side by side like so:
breez-sdk/
ββ libs/
β ββ sdk-flutter/
ββ tools/
ββ LICENSE
ββ README.md
c-breez/
ββ android/
ββ ios/
c-breez depends on google services and requires a configured firebase app.
To create your firebase app follow the following link create-firebase-project.
After creating the app follow the instructions to create the specific configuration file for your platform:
flutter build apk
flutter build ios
flutter run
A testing framework for this project is being developed here.
flutter test integration_test -d <<device id>>
dart format
with LefthookLefthook is a Git hooks manager that allows custom logic to be
executed prior to Git commit or push. c-Breez comes with Lefthook configuration (lefthook.yml
), but it must
be installed first.
$ lefthook install
Before you commit your changes, Lefthook will automatically run dart format
.
Should the need arise to skip pre-commit
hook, CLI users can use the standard Git option --no-verify
to skip pre-commit
hook:
$ git commit -m "..." --no-verify
There currently is no Github Desktop support to skip git-hooks. However, you can run:
$ lefthook uninstall
to clear hooks related to lefthook.yml
configuration before committing your changes.
Do no forget to run lefthook install
to re-activate pre-commit
hook.
$ lefthook install
For troubleshooting, please check the troubleshooting.md file