<img align="right" width="112" height="42" title="Breez logo" src="./src/images/liquid-logo-color.svg">
l-Breez is a migration of Breez mobile app to the Breez Liquid SDK infrastructure.
l-Breez depends on Breez Liquid SDK's breez_liquid & flutter_breez_liquid plugin, so be sure to follow those instructions first.
After successfully having build the breez_liquid
& flutter_breez_liquid
make sure that breez-sdk-liquid
and l-breez are side by side like so:
breez-sdk-liquid/
├─ lib/
│ ├─ bindings/
│ ├─ core/
├─ packages/
│ ├─ dart/
│ ├─ flutter/
l-breez/
├─ android/
├─ ios/
l-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 --target=lib/main/main.dart
flutter build ios --target=lib/main/main.dart
flutter run --target=lib/main/main.dart
dart format
with LefthookLefthook is a Git hooks manager that allows custom logic to be
executed prior to Git commit or push. l-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