From 73339666bd0064fa79ce787360003cfd7ca46965 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Fri, 14 Sep 2018 21:32:18 -0400 Subject: [PATCH] READ ME READ ME --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e4f4503..c9af3791 100644 --- a/README.md +++ b/README.md @@ -1 +1,53 @@ -# RTL +# 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. + +This UI builds upon the below raspberry pi guide: +https://github.com/Stadicus/guides/blob/master/raspibolt/README.md + +## Prerequisites +Please ensure that you have completed the installation of lightning node on your raspberry pi, based on the above guide. + +It can be either on testnet or mainnet + +## Installation + +Fetch sources from the RTL git repository: + +`git clone https://github.com/ShahanaFarooqui/RTLFullApplication.git` + +Move into the newly created directory: + +`cd RTLFullApplication` + +Move into the install 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 on your pi. + +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 /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` + +Open your browser at the following address: http://localhost:3000 to access the RTL application on your pi.