GlcoinCore/jam
1
0
Fork 0
mirror of https://github.com/joinmarket-webui/jam.git synced 2026-08-15 12:50:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
188 commits 32 branches 24 tags 48 MiB
Find a file
Thebora Kompanioni 90fa57374b
test: add basic test suite (#130) 
* test: add basic test for App component

* test: add basic test for Wallets component

* Debug log only in dev env (spare test environment)

* ci: enable tests in GitHub build workflow

Co-authored-by: Dennis Reimann <mail@dennisreimann.de>
2022-03-03 11:04:31 +01:00
.github/workflows test: add basic test suite (#130) 2022-03-03 11:04:31 +01:00
.husky feat: setup code formatting (#21) 2022-01-27 10:20:31 +01:00
docker/regtest feat: allow for deployment in subdirectory (#129) 2022-03-02 12:37:29 +01:00
docs docs: update integrations in readme (#144) 2022-03-02 15:57:14 +01:00
public feat: allow for deployment in subdirectory (#129) 2022-03-02 12:37:29 +01:00
scripts devtools: document and further automate release process (#112) 2022-02-18 11:05:46 +01:00
src test: add basic test suite (#130) 2022-03-03 11:04:31 +01:00
.gitignore Use npm instead of yarn 2021-11-29 17:24:39 +01:00
.npmrc devtools: document and further automate release process (#112) 2022-02-18 11:05:46 +01:00
CHANGELOG.md chore(release): prepare v0.0.3 (#113) 2022-02-18 19:23:59 +01:00
CONTRIBUTING.md docs: add contribution guide and refactor docs (#119) 2022-02-23 11:12:10 +01:00
LICENSE Add MIT license and update package info 2021-12-22 16:06:25 +01:00
package-lock.json test: add basic test suite (#130) 2022-03-03 11:04:31 +01:00
package.json test: add basic test suite (#130) 2022-03-03 11:04:31 +01:00
readme-header.svg Update readme (#8) 2022-01-21 18:11:28 +01:00
README.md docs: update integrations in readme (#144) 2022-03-02 15:57:14 +01:00

README.md


JoinMarket Web UI

JoinMarket Web UI

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

Integrations · Features · Installation · Development

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.

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

*JoinMarket Web UI 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 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.

✨ 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.