Tom Kirkpatrick 047aa94b69 feat(github): add github issue templates Add issue templates for github bug reports, feature requests and pull requests to help gather as much information as possible from users submitting issues or PR's. Templates generated with the help of: https://www.talater.com/open-source-templates/#/page/1		6 years ago
.github	feat(github): add github issue templates	6 years ago
.vscode	first commit	8 years ago
app	Merge pull request #710 from kaloudis/humanFriendlyErrors	6 years ago
flow-typed	first commit	8 years ago
internals	build: packaging support for multiple arch	7 years ago
resources	feat(lnd): update lnd to v0.4.2-beta-913-g26f68da5	6 years ago
test	Merge pull request #710 from kaloudis/humanFriendlyErrors	6 years ago
.babelrc	build(electron): update to electron v2.0.2	7 years ago
.commitlintrc	build(lint): validate commit message format	7 years ago
.editorconfig	first commit	8 years ago
.eslintignore	refactor: move helper code to lib directory	6 years ago
.eslintrc	fix: improve lnd log line matching	7 years ago
.flowconfig	build(flow): include node_modules in flow config	6 years ago
.gitattributes	Disables text treatment of binary resources	7 years ago
.gitignore	test(coverage): generate code coverage reports	7 years ago
.huskyrc	style(husky hooks): drop opt --in from husky hooks	7 years ago
.lintstagedrc	build(lint): lint/format in git pre-commit hook	7 years ago
.prettierignore	build(lint): auto code formatting with prettier	7 years ago
.prettierrc	style(line length): Drop prettier line length from 120 to 100	7 years ago
.stylelintignore	refactor: move styles to styles directory	7 years ago
.stylelintrc	style: disable no-empty-source stylelint rune	7 years ago
.travis.yml	build(release): auto release on ci	7 years ago
ADVANCED.md	feat(lnd): require explicit connection config	6 years ago
CONTRIBUTING.md	style(husky hooks): drop opt --in from husky hooks	7 years ago
LICENSE	docs: improve documentation	7 years ago
README.md	docs(readme): add appveyor build status badge	7 years ago
appveyor.yml	build(release): auto release on ci	7 years ago
package.json	feat(lnd): update lnd to v0.4.2-beta-913-g26f68da5	6 years ago
webpack.config.base.js	perf(bundle-size): only en locale from moment	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	build(webpack): remove redundant environment check	7 years ago
webpack.config.renderer.dev.dll.js	build(webpack): remove redundant environment check	7 years ago
webpack.config.renderer.dev.js	feat(fiat): persist fiatTicker	6 years ago
webpack.config.renderer.prod.js	feat(fiat): persist fiatTicker	6 years ago
yarn.lock	chore(deps): update jest to v23.5.0	6 years ago

README.md

Zap

Lightning wallet focused on user experience and ease of use ⚡️

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.

The UI for Zap is created using Electron + React + Redux.

We have an active slack channel where you can join the discussion on development, design and product.

Security
Install
Usage
Advanced Usage
Get Help
Maintainers
Contribute
License

Security

If you discover or learn about a potential error, weakness, or threat that can compromise the security of Zap, we ask you to keep it confidential and submit your concern directly to the Zap security team.

Install

Download the latest release for your appropriate OS and follow the instructions below.

macOS

Once you have the .tar.gz file downloaded, simply double click on the file to unzip.

Navigate to the newly extracted folder, then drag-and-drop the Zap.app file to the Applications folder.

Unmount the image and navigate to Applications folder.

Finally, double click on the Zap.app file.

Windows

Once you have the .exe file downloaded, simply double click on the file.

Linux

Once you have the .zip file downloaded, simply double click the file to unzip or run the following command:

unzip file.zip

You have the option to either install Zap through the .deb or .AppImage files.

.deb File

Once you have the .deb file extracted, you can install Zap by double clicking on the file or through the dpkg command:

sudo dpkg -i file.deb

If this is your first time installing zap, you may have some unmet dependencies. This can be resolved with the following command:

sudo apt-get -f install

To run Zap you can either navigate through the GUI or run the following command:

zap-desktop

.AppImage File

Once you have the .AppImage file extracted, you can either double click the file or by running in the cli:

./file.AppImage

Advanced Usage

If you would like to install from source, run a full bitcoin node, or connect to a custom lnd instance please see the advanced usage page.

Get Help

If you are having problems with Zap, please report the issue in GitHub or on slack with screenshots and/or how to reproduce the bug/error.

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 is a very important design principle of Zap.

Maintainers

Contribute

Hey! Do you like Zap? Awesome! We could actually really use your help!

Open source isn't just writing code. Zap could use your help with any of the following:

Finding (and reporting!) bugs
New feature suggestions
Answering questions on issues
Documentation improvements
Reviewing pull requests
Helping to manage issue priorities
Fixing bugs/new features

If any of that sounds cool to you, feel free to dive in! Open an issue or submit a pull request.

If you would like to help contribute to the project, please see the Contributing Guide

This project exists thanks to all the people who contribute.

License

This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. See LICENSE for more information.