Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Zap Wallet - Cross platform Lightning Network wallet focused on user experience and ease of use ⚡️
https://github.com/LN-Zap/zap-desktop

lightning-network lightning-network-wallet zapwallet

Last synced: 8 days ago
JSON representation

Zap Wallet - Cross platform Lightning Network wallet focused on user experience and ease of use ⚡️

Awesome Lists containing this project

README

        

# Zap (UNMAINTAINED)

Zap Desktop is not actively maintained at the moment. If you're looking for a simple way to make lightning transactions take a look at [Strike](https://strike.me/).



screenshot

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

![GitHub All Releases](https://img.shields.io/github/downloads/LN-Zap/zap-desktop/total) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/zap-desktop/localized.svg)](https://crowdin.com/project/zap-desktop) [![GitHub license](https://img.shields.io/github/license/LN-Zap/zap-desktop.svg?style=flat-green)](LICENSE)
[![dependencies Status](https://david-dm.org/LN-Zap/zap-desktop/status.svg)](https://david-dm.org/LN-Zap/zap-desktop)
[![Build Status](https://img.shields.io/travis/LN-Zap/zap-desktop/master.svg?style=flat-green&label=mac%20/%20linux&logo=travis)](https://travis-ci.org/LN-Zap/zap-desktop) [![Build status](https://img.shields.io/appveyor/ci/LN-Zap/zap-desktop/master.svg?style=flat-green&label=windows&logo=appveyor)](https://ci.appveyor.com/project/LN-Zap/zap-desktop/branch/master) [![Coverage Status](https://coveralls.io/repos/github/LN-Zap/zap-desktop/badge.svg?branch=master)](https://coveralls.io/github/LN-Zap/zap-desktop?branch=master) [![GitHub Release](https://badgen.net/github/release/LN-Zap/zap-desktop/)](https://github.com/LN-Zap/zap-desktop/releases/latest) [![Keybase Verify](https://badgen.net/keybase/pgp/ln_zap)](https://keybase.io/ln_zap) [![Twitter Follow](https://img.shields.io/twitter/follow/ln_zap?style=social)](https://twitter.com/ln_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.

The UI for Zap is created using
[Electron](https://electron.atom.io/) + [React](https://facebook.github.io/react/) + [Redux](https://github.com/reactjs/redux/tree/master/docs).

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

## Table of Contents

- [Security](#security)
- [Install](#install)
- [Usage](#usage)
- [Documentation](#documentation)
- [Get Help](#get-help)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#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](mailto:[email protected]?subject=[GitHub]%20Zap%20Security).

## Install

Download the [latest release][releases] 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 .AppImage file downloaded you must [make the file executable](https://docs.appimage.org/user-guide/run-appimages.html).

Once executible you can run either **double click** the file or run via the cli:

```bash
./file.AppImage
```

## Documentation

If you would like to install from source, run a full bitcoin node, connect to a custom lnd instance or get involved with development please refer to our documentation:

- [Advanced usage](docs/ADVANCED.md)
- [Configuration](docs/CONFIG.md)
- [Contributing](docs/CONTRIBUTING.md)
- [Debugging](docs/DEBUGGING.md)
- [Troubleshooting](docs/TROUBLESHOOTING.md)
- [Releasing](docs/RELEASING.md)
- [Signatures](docs/SIGNATURES.md)

## Get Help

If you are having problems with Zap, please report the issue in [GitHub][issues] or on [slack][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

- [Jack Mallers (@JimmyMow)](https://github.com/JimmyMow)
- [Tom Kirkpatrick (@mrfelton)](https://github.com/mrfelton)

## 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][issues] or submit a pull request.

If you would like to help contribute to the project, please see the [Contributing Guide](docs/CONTRIBUTING.md)

This project exists thanks to all the people who contribute.

[mrfelton](https://github.com/mrfelton)[JimmyMow](https://github.com/JimmyMow)[korhaliv](https://github.com/korhaliv)[Empact](https://github.com/Empact)[bolatovumar](https://github.com/bolatovumar)[jackmallers](https://github.com/jackmallers)[odb366](https://github.com/odb366)[zobroj](https://github.com/zobroj)[joaodealmeida](https://github.com/joaodealmeida)[helgabutters](https://github.com/helgabutters)[pajasevi](https://github.com/pajasevi)[DataCourier](https://github.com/DataCourier)[thedon-chris](https://github.com/thedon-chris)[jimpo](https://github.com/jimpo)[dfattlar](https://github.com/dfattlar)[NahomAgidew](https://github.com/NahomAgidew)[asoltys](https://github.com/asoltys)[leon-do](https://github.com/leon-do)[seanyesmunt](https://github.com/seanyesmunt)[tbloncar](https://github.com/tbloncar)[waseem999](https://github.com/waseem999)[dependabot[bot]](https://github.com/apps/dependabot)[jamaljsr](https://github.com/jamaljsr)[jtarre](https://github.com/jtarre)[RandyMcMillan](https://github.com/RandyMcMillan)[musdom](https://github.com/musdom)[alvistar](https://github.com/alvistar)[BrianSipple](https://github.com/BrianSipple)[karliatto](https://github.com/karliatto)[dimitris-t](https://github.com/dimitris-t)[kaloudis](https://github.com/kaloudis)[thinkjanis](https://github.com/thinkjanis)[jorian](https://github.com/jorian)[lukechilds](https://github.com/lukechilds)[wraithm](https://github.com/wraithm)[QcMrHyde](https://github.com/QcMrHyde)[CallMeSlinky](https://github.com/CallMeSlinky)[michaelWuensch](https://github.com/michaelWuensch)[foxikk](https://github.com/foxikk)[fresheneesz](https://github.com/fresheneesz)[funyug](https://github.com/funyug)[losh11](https://github.com/losh11)[terencechow](https://github.com/terencechow)[gtonic](https://github.com/gtonic)

## 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](LICENSE) for more information.

[MIT](LICENSE) © Jack Mallers

[issues]: https://github.com/LN-Zap/zap-desktop/issues
[releases]: https://github.com/LN-Zap/zap-desktop/releases
[slack]: https://join.slack.com/t/zaphq/shared_invite/zt-roz0lalj-6fVdYQlLnpuM2c2QTvFgxA