aaj013 / lndart.clnapp-hacktober

CLN App is an experimental cross platform app to manage your core lightning node from any kind of platform

lndart.clnapp

🎯 Cross platform app to manage remotely and locally a core lightning node 🎯

Project Homepage | CLNAPP webapp

Table of Content

• Introduction
• How to Build
  • Installation
    • Linux
    • Chrome
    • Emulator
    • Android
    • iOS
• How to Contribute
• License

Introduction

A cross platform application to effortlessly manage your core lightning node using multiple cln clients.

Core lightning clients which are supported by lndart.clnapp:

Core Lightning Client	Description	Version
cln_grpc	A dart library which facilitates dart gRPC client for core lightning.
lnlambda	Minimal interface to run lnlambda function with dart.
cln_rpc	A RPC wrapper around the core lightning API.

How to Build

Installation

• Clone the lndart.clnapp repository.

sudo git clone https://github.com/dart-lightning/lndart.clnapp.git

• Get flutter dependencies

make dep
make get

Linux(desktop)

• Enable the linux desktop to run the application

sudo apt-get install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
flutter config --enable-linux-desktop
flutter run -d linux

Chrome(web)

flutter run -d chrome

• The clnapp webapp is also deployed using github pages Checkout here.

Emulator Android & iOS

• Find the device-id of Android/iOS emulator device connected

flutter devices

• Run the flutter application using device-id

flutter run -d <device-id>

Android device

• Build the .apk file for Android application

flutter build apk

• The apk file generated can be found inside [project]/build/app/outputs/bundle/release/

iOS device

• Build the .xarchive file for iOS application

flutter build ipa

• The Xcode build archive (.xcarchive file) generated can be found inside [project]/build/ios/archive/ directory and an App Store app bundle (.ipa file) in [project]/build/ios/ipa/

How to Contribute

Read our Hacking guide

License