c-Breez is a migration of Breez mobile app to the Greenlight infrastructure.
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:
- For android - place the google-services.json in the android/app folder
- For iOS - place the GoogleService-info.plist under ios/Runner folder
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>>
Lefthook 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.
- Install Lefthook. See installation guide.
- Run the following command from project root folder to install hooks:
$ lefthook installBefore 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-verifyThere currently is no Github Desktop support to skip git-hooks. However, you can run:
$ lefthook uninstallto 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 installFor troubleshooting, please check the troubleshooting.md file