/joinmarket-webui

Project board: https://github.com/orgs/joinmarket-webui/projects/1/

Primary LanguageJavaScriptMIT LicenseMIT


JoinMarket Web UI

JoinMarket Web UI

⚠️ This is still work in progress. Use with caution. ⚠️


A web UI for JoinMarket with a focus on user-friendliness. The UI aims to provide sensible defaults and be easy to use for beginners while still providing the features advanced users expect.

  • 💬 Join our Telegram group.
  • 📚 Check out the Wiki for resources such as meeting notes, call recordings, ideas, and discussions.

This project builds upon work done by Shobhitaa, Abhishek, and Adam (waxwing) himself: JoinMarket-Org/jm-web-client.

📦 Integrations

We're aiming to make the JoinMarket Web UI available for different node systems. If your node of choice is missing, feel free to integrate it and let us know so we can add it here.

The alpha version of the JoinMarket Web UI is available as CLI install in RaspiBlitz v1.7.2. To install it, exit the Raspiblitz menu and run:

config.scripts/bonus.joinmarket-webui.sh on

To get information on how to connect to the JoinMarket Web UI run:

config.scripts/bonus.joinmarket-webui.sh menu

We're aiming for a more stable version to be available as a one-click app install with RaspiBlitz v1.8.0.

Umbrel integration is work in progress.

Citadel integration is work in progress.

✨ Features

  • Spending from the wallet
  • Spending from the wallet via collaborative transactions
  • Running the yield generator
  • TBD

💪 Participating

This is a free and open-source software project and we love receiving pull-requests, bug reports, ideas, and feedback from everyone. See CONTRIBUTING.md for how to get started participating in this project.

Developing

See docs/developing.md for additional developer docs.

💻 Running Locally

See docs/developing.md for how to run the Web UI locally and connect it to a JoinMarket instance.