Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 3.39 KB

README.md

File metadata and controls

116 lines (82 loc) · 3.39 KB
Raw

Build Android workflow Build iOS workflow CI workflow

Misty Breez

Misty Breez is a migration of Breez mobile app to the Breez Liquid SDK infrastructure.

Build

Build the lightning_tookit plugin

Misty 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 misty-breez are side by side like so:

breez-sdk-liquid/
├─ lib/
│  ├─ bindings/
│  ├─ core/
├─ packages/
│  ├─ dart/
│  ├─ flutter/
misty-breez/
├─ android/
├─ ios/

Add Firebase configuration

FlutterFire CLI currently requires the official Firebase CLI to also be installed, see Install the Firebase CLI for how to install it.

After installing Firebase CLI, log into Firebase using your Google account by running the following command:

firebase login

then, install the FlutterFire CLI by running the following command from any directory:

dart pub global activate flutterfire_cli

From Flutter project directory, run the following command to start the app configuration workflow:

flutterfire configure -p breez-technology -o lib/firebase/firebase_options.dart --platforms="android,ios" -a com.breez.liquid.l_breez -y

Android

flutter build apk --target=lib/main/main.dart

iOS

flutter build ios --target=lib/main/main.dart

Run

flutter run --target=lib/main/main.dart

Contributors

Pre-commit dart format with Lefthook

Lefthook is a Git hooks manager that allows custom logic to be executed prior to Git commit or push. Misty Breez comes with Lefthook configuration (lefthook.yml), but it must be installed first.

Installation

  • Install Lefthook. See installation guide.
  • Run the following command from project root folder to install hooks:
$ lefthook install

Before you commit your changes, Lefthook will automatically run dart format.

Skipping hooks

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

Troubleshooting

For troubleshooting, please check the troubleshooting.md file