diff --git a/Application_features.md b/Application_features.md new file mode 100644 index 00000000..7670f3cf --- /dev/null +++ b/Application_features.md @@ -0,0 +1,26 @@ +# RTL - Feature List + +## Home Page (Dashboard and Node Status) +- Wallet Balance +- Number of Peers connected +- Number of Active channels +- Channel Balance +- Chain Sync status indicator +- Fee Report +- Network Info + +## LND Wallet (Wallet functions available on LND) +- Total Balance +- Confirmed Balance +- Unconfirmed Balance +- Generate Address (with QR Code) +- Send funds + +## Peers (Manage LN Peers) +- Connect to a peer with the LN Public key and IP address +- List of connected peers + +## Channels (Manage channels with network peers) +- Channel Status (Number of Active, Inactive and Pending channels) +- Open Channel with connected peers +- List of channels diff --git a/README.md b/README.md index 8806d9df..31af27dd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[ **Intro** ] -- [ [Application Features](Application_features.md) ] +----- # RTL - Ride The Lightning RTL is a web UI for Lightning Network Daemon. @@ -51,4 +53,14 @@ If the server started successfully, you should get the below output on the conso `Server is up and running, please open the UI at http://localhost:3000` +## Accessing the Application + +You can access the application in two ways: +### Same computer as the webserver Open your browser at the following address: http://localhost:3000 to access the RTL application. + +### Remotely from another computer on the same local network as the node +To access the application remotely from a computer, ensure that the firewall running on your node allows access on port 3000. +You would need the IP address of your application to access the application. + +E.g. if the IP address of your node is 192.168.0.15 then open your browser at the following address: http://192.168.0.15:3000 to access RTL.