Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/UnstoppableSwap/unstoppableswap-gui

Graphical User Interface (GUI) For Trustless Cross-Chain XMR<>BTC Atomic Swaps
https://github.com/UnstoppableSwap/unstoppableswap-gui

Last synced: 12 days ago
JSON representation

Graphical User Interface (GUI) For Trustless Cross-Chain XMR<>BTC Atomic Swaps

Awesome Lists containing this project

README

        




UnstoppableSwap GUI


Graphical User Interface (GUI) For Trustless Cross-Chain XMR<>BTC Atomic Swaps




Download
.
Report Bug
.
Request Feature


🌟 Consider supporting our crowdfunding proposal 💰🚀

![Downloads](https://img.shields.io/github/downloads/UnstoppableSwap/unstoppableswap-gui/total) ![Contributors](https://img.shields.io/github/contributors/UnstoppableSwap/unstoppableswap-gui?color=dark-green) ![Issues](https://img.shields.io/github/issues/UnstoppableSwap/unstoppableswap-gui) ![License](https://img.shields.io/github/license/UnstoppableSwap/unstoppableswap-gui)

## Table Of Contents

- [Documentation](#documentation)
- [Getting Started with Development](#getting-started)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)

![main screen](https://github.com/UnstoppableSwap/unstoppableswap-gui/assets/86064887/75634e8e-73da-4ba2-8287-8e99171cd329)

## [Documentation](https://docs.unstoppableswap.net/)

Please note that the documentation is still a work in progress.

## Getting Started

Please download the GUI from the [release page](https://github.com/UnstoppableSwap/unstoppableswap-gui/releases). Choose your respective version (.dmg for Mac, .AppImage for Linux and .exe for Windows).

## Donate

We rely on generous donors like you to keep development moving forward. To bring Atomic Swaps to life, we need resources. If you have the possibility, please consider making a donation to the project. All funds will be used to support contributors and critical infrastructure.

If you interested in a partnership or want to support the project in a way that requires coordination with the contributors, contact `@binarybaron:matrix.org` on Matrix.

```filename="Monero Donation Address
49LEH26DJGuCyr8xzRAzWPUryzp7bpccC7Hie1DiwyfJEyUKvMFAethRLybDYrFdU1eHaMkKQpUPebY4WT3cSjEvThmpjPa
```

```filename="Monero Donation Address
bc1qz6lfs0r206396a9psunmkfpqh7sdf2zh3e7tnf
```

## Development

To get a local copy up and running follow these steps.

### Prerequisites

Before proceeding you should install the following:

- [node (v16)](https://nodejs.org/en/download/)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

### Installation

Clone the repository, install all dependencies using npm and start the GUI on testnet.

```bash
git clone --branch main https://github.com/binarybaron/unstoppableswap-gui
cd unstoppableswap-gui
npm install
```

```bash
TESTNET=true npm start
```

## Roadmap

See the [open issues](https://github.com/UnstoppableSwap/unstoppableswap-gui/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

- If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/UnstoppableSwap/unstoppableswap-gui/issues/new) to discuss it, or directly create a pull request after you edit the _README.md_ file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.

### Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See [LICENSE](https://github.com/UnstoppableSwap/unstoppableswap-gui/blob/main/LICENSE.md) for more information.

## Acknowledgements

- [thomaseizinger (Thomas Eizinger)](https://github.com/thomaseizinger)
- [da-kami (Daniel Karzel)](https://github.com/da-kami)
- [rishflab](https://github.com/rishflab)
- [bonomat (Philipp Hoenisch)](https://github.com/bonomat)
- [luckysori (Lucas Soriano)](https://github.com/luckysori)
- [D4nte (Franck R.)](https://github.com/D4nte)