djo1e / joinmarket-webui Goto Github PK

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

Jam is a web UI for JoinMarket with focus on user-friendliness. It 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.

We're aiming to make Jam 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.

RaspiBlitz: v1.7.2*	Umbrel: v0.4.15	Citadel: v0.0.1

*Jam is available as CLI install in RaspiBlitz v1.7.2. To install it, exit the Raspiblitz menu and run:

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

To get information on how to connect to Jam 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.

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

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.

See docs/developing.md for additional developer docs.

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