mirrors/Ride-The-Lightning-RTL
1
0
Fork 0
mirror of https://github.com/Ride-The-Lightning/RTL.git synced 2024-11-19 01:40:29 +01:00
Code Issues Projects Releases Wiki Activity
Ride The Lightning - A full function web browser app for LND, C-Lightning and Eclair
37 Commits 31 Branches 104 Tags 456 MiB
JavaScript 57.2%
TypeScript 18.9%
CSS 12.5%
HTML 10.5%
SCSS 0.9%
5635667a9c
Go to file
saubyk 5635667a9c
Update README.md
2018-10-07 18:04:25 -04:00
angular Config path unix validation 2018-10-06 18:27:30 -04:00
controllers Relative Directory Fix 2018-10-06 20:02:34 -04:00
routes Server Config Read 2018-10-01 19:11:28 -04:00
settings Relative Directory Fix 2018-10-06 20:02:34 -04:00
.DS_Store Initial commit 2018-09-14 21:31:01 -04:00
.gitattributes Initial commit 2018-09-14 21:31:01 -04:00
.gitignore Ignore node_modules 2018-09-15 18:50:55 -04:00
app.js Server Config Read 2018-10-01 19:11:28 -04:00
Application_features.md Create Application_features.md 2018-09-27 21:34:25 -04:00
config.js Initial commit 2018-09-14 21:31:01 -04:00
connect.js Initial commit 2018-09-14 21:31:01 -04:00
LICENSE Create LICENSE 2018-09-27 22:23:50 -04:00
package-lock.json LND Wallet Complete 2018-09-27 22:20:43 -04:00
package.json LND Wallet Complete 2018-09-27 22:20:43 -04:00
README.md Update README.md 2018-10-07 18:04:25 -04:00
rtl.js API resolution fix 2018-09-16 16:43:35 -04:00

README.md

[ Intro ] -- [ Application Features ]

RTL - Ride The Lightning

RTL is a web UI for Lightning Network Daemon.

Lightning Network Daemon is an implementation of Lightning Network BOLT protocol by Lightning Labs (https://lightning.engineering/).

Visit their Github repo (https://github.com/lightningnetwork/lnd/blob/master/README.md) for details on Lightning Network and LND implementation.

For setting up your Lightning Network node, you can follow the below guide: https://github.com/Stadicus/guides/blob/master/raspibolt/README.md

Prerequisites

Please ensure that you have completed the installation of LND lightning node.

Its recommended to run this application on testnet, untill the aplha testing phase is over.

Recommended Browsers: Chrome, Chromium (rpi), MS Edge.

Installation

Fetch sources from the RTL git repository, by executing the below command at the command prompt:

git clone https://github.com/ShahanaFarooqui/RTL.git

Move to the newly created directory:

cd RTL

Fetch the dependencies and build the application by running:

npm install

Execution

Make sure you are in the RTL directory, where the application was built.

Locate the complete path of the readable macroon file (admin.macroon) on your node.

If you followed the guide above, it should be /home/admin/.lnd.

This path needs to be provided as a command line argument to start the server

Start the Webserver

Run the following command:

node rtl --lndir <macaroon-path>

For example: node rtl --lndir /home/admin/.lnd

If the server started successfully, you should get the below output on the console:

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.