Skip to content

Latest commit

 

History

History
140 lines (88 loc) · 9.19 KB

README.md

File metadata and controls

140 lines (88 loc) · 9.19 KB
Raw

Zap

screenshot

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

dependencies Status Coverage Status Build Status Build status GitHub license

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.

Table of Contents

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.

JimmyMowmrfeltonEmpactjackmallersrenovate[bot]odb366VonIobrohelgabuttersjoaodealmeidapajaseviDataCourierjimpodfattlarNahomAgidewasoltystbloncarwaseem999jamaljsrjtarrewraithmmusdomdimitris-tkaloudisthinkjanisn41r0jlukechildskarliattoCallMeSlinkymichaelWuenschfresheneeszfunyuglosh11terencechow

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.

MIT © Jack Mallers