JimmyMow ecbe91c5df Merge pull request #154 from Empact/enhance/travis-parallel Bring CI runtime down from ~19 to ~13 minutes		7 years ago
.vscode	first commit	7 years ago
app	fix(unified-close-icons): Removed duplicate declaration, fix for stylelint	7 years ago
flow-typed	first commit	7 years ago
internals	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
resources	fix(lnd): remove lnd	7 years ago
test	fix(e2e-tests): Drop irrelevant e2e tests	7 years ago
.babelrc	first commit	7 years ago
.editorconfig	first commit	7 years ago
.eslintignore	first commit	7 years ago
.eslintrc	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
.flowconfig	fix(flow): Exclude app/node_modules from flow checks	7 years ago
.gitattributes	Disables text treatment of binary resources	7 years ago
.gitignore	fix(gitignore): ignore resources/bin	7 years ago
.stylelintrc	first commit	7 years ago
.travis.yml	enhance(ci-runtime): Run CI tasks in parallel	7 years ago
CONTRIBUTING.md	feature(contributing)	7 years ago
LICENSE	first commit	7 years ago
README.md	fix(slack): fix slack invitation links	7 years ago
appveyor.yml	first commit	7 years ago
package.json	enhance(ci-runtime): Run CI tasks in parallel	7 years ago
webpack.config.base.js	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
webpack.config.eslint.js	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
webpack.config.main.prod.js	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
webpack.config.renderer.dev.dll.js	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
webpack.config.renderer.dev.js	fix(custom icon importing)	7 years ago
webpack.config.renderer.prod.js	Removes unused code, adds proper semicolon rule and reduces lint errors	7 years ago
yarn.lock	fix(flow): Add ps-node as a dev dependency	7 years ago

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, and uses Electron + React + Redux for the UI.

Join us on slack to discuss development, design and product

Requirements

Node.js version >= 7, npm version >= 4 and yarn

Install

If you have installation or compilation issues, please file a Github issue or ping us in Slack

After installing the above requirements, clone the repo via git:

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

And then install dependencies with yarn + install grpc

$ cd zap-desktop
$ yarn
$ npm run install-grpc

Zap does not store lnd binaries in the Github repo so you will now need to go install lnd. You can then copy the lnd binary that will be located in your $GOPATH/bin and paste it into Zap. Zap expectes lnd to be in one of these directories depending on your OS:

# mac
resources/bin/darwin

#linux
resources/bin/linux

#win32
resources/bin/win32

Then to start it:

$ npm run dev

Test

$ npm run test

Lint

$ npm run lint

Contributing:

Please see the contributing guide

Todos (Last updated August 16th):

Join us on slack before tackling a todo to avoid duplicate work.

The old todo list was recently removed. Come on slack or check open Github issues to see what contributions are needed.

Q & A (Quality and Assurance)

A good product not only has good software tests but also checks the quality of the UX/UI. Putting ourselves in the shoes of a user will be very important for Zap.

If you see issues please report with screenshots and/or how to reproduce the bug/error

Devices

Mac
Windows
Linux

Example user stories

User wants to connect to a peer

User wants to open a channel

User wants to create a payment request

User wants to make a payment