zap-desktop/README.md

Zap

Zap is a free Lightning Network wallet focused on user experience and ease of use, with the overall goal of helping the cryptocurrency community scale Bitcoin and other cryptocurrencies.

Zap is built on top of LND, uses a Node.js proxy and, Electron + React + Redux for the UI.

Join us on slack to discuss development, design and product

Install

For now Zap assumes you are running BTCD and LND (will change soon). Please see installation to get that setup first

• Note: requires a node version >= 7 and an npm version >= 4.
• If you have installation or compilation issues, please file a Github issue

First, clone the repo via git:

git clone https://github.com/LN-Zap/zap-desktop.git

And then install dependencies with yarn

$ cd zap-desktop
$ yarn

Current Todo List (Last updated August 15th)

Join us on slack before tackling a todo to avoid duplicate work. This list will be updated daily to show what todos are being worked on

Refactor

• Move Node.js proxy to ipcRenderer (roasbeef recommendation)
• Payments modal using selector
• Invoices modal using selector
• Use two package.json structure
• General refactor (I know this TODO sucks but the code is a bit sloppy still, need to spend time refactoring)

Features

• Configurable BTCD + LN node connection (do not assume/rely on localhost)
• Error handling
• List on-chain transactions
• Websocket handling for transactions
• Websocket handling for sendpayment
• Channel notifications
• Payment notifications
• Transaction notifications
• Generate newaddress for the wallet deposit
• Litecoin UI
• Settings route
• describegraph UI to see current status of the Lightning Network

Design

• Error handling
• On-chain transactions list
• Notifications
• Litecoin UI (pick out a silver main color)
• describegraph UI to see current status of the Lightning Network