mirror of
https://github.com/joinmarket-webui/jam.git
synced 2026-08-13 12:33:26 +02:00
Add MIT license and update package info
This commit is contained in:
parent
89e4d910ab
commit
da527bca86
4 changed files with 36 additions and 20 deletions
5
LICENSE
Normal file
5
LICENSE
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
29
README.md
29
README.md
|
|
@ -1,11 +1,15 @@
|
|||
# Web client for joinmarket
|
||||
# JoinMarket Web UI
|
||||
|
||||
There is a Web UI prototype, written in React, which has some initial functionality. The prototype builts upon work done by [Shobhitaa](https://github.com/shobhitaa), [Abhishek](https://github.com/abhishek0405), and [Adam](https://github.com/AdamISZ) (waxwing) himself. The screenshots below are from commit [ba26cf637076444c7fadc82f6538eee5bd3b796a](https://github.com/joinmarket-webui/jm-web-client/commit/ba26cf637076444c7fadc82f6538eee5bd3b796a).
|
||||
For now this repository is supposed to be a central place to collect resources related to the JoinMarket Web UI project.
|
||||
We'll see what collaboration tools suit use as we go forward.
|
||||
Suggestions and feedback welcome!
|
||||
|
||||
- 🔗 Join our [Telegram group](https://t.me/JoinMarketWebUI).
|
||||
- 👉 Check out the [Wiki](https://github.com/joinmarket-webui/joinmarket-webui/wiki) for resources such as meeting notes, call recordings, ideas, and discussions.
|
||||
|
||||
This project builts upon work done by [Shobhitaa](https://github.com/shobhitaa), [Abhishek](https://github.com/abhishek0405), and [Adam](https://github.com/AdamISZ) (waxwing) himself.
|
||||
GitHub repository: [JoinMarket-Org/jm-web-client](https://github.com/JoinMarket-Org/jm-web-client)
|
||||
|
||||

|
||||
|
||||
## Local development
|
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
|
|
@ -39,9 +43,10 @@ See the section about [deployment](https://facebook.github.io/create-react-app/d
|
|||
|
||||
## Setup
|
||||
|
||||
While this prototype will hopefully be available as a packaged version soon, here is how you can set it up and play around with it yourself.
|
||||
Here is how you can set it up and play around with it yourself.
|
||||
|
||||
### Docker (regtest)
|
||||
|
||||
See the [docker regtest setup readme](docker/regtest/readme.md).
|
||||
|
||||
### RaspiBlitz Setup
|
||||
|
|
@ -50,9 +55,9 @@ See the [docker regtest setup readme](docker/regtest/readme.md).
|
|||
|
||||
1. Install [JoininBox](https://github.com/openoms/joininbox) on your [RaspiBlitz](https://github.com/rootzoll/raspiblitz):
|
||||
|
||||
You can install it via the RaspiBlitz Services menu: ```Services > j [BTC JoinMarket+JoininBox menu]```
|
||||
You can install it via the RaspiBlitz Services menu: `Services > j [BTC JoinMarket+JoininBox menu]`
|
||||
|
||||
This prototype makes use of the JoinMarket [RPC API](https://github.com/JoinMarket-Org/joinmarket-clientserver/pull/996).
|
||||
This app makes use of the JoinMarket [RPC API](https://github.com/JoinMarket-Org/joinmarket-clientserver/pull/996).
|
||||
For this, you will need JoinMarket [version 0.9.3](https://github.com/JoinMarket-Org/joinmarket-clientserver/releases/tag/v0.9.3) or higher.
|
||||
If needed you can upgrade JoinMarket to the latest commit via the JoininBox menu on your RaspiBlitz: Type `jm` in the command line and select ```UPDATE > ADVANCED > JMCOMMIT```.
|
||||
This will install the latest development version from JoinMarket's master branch.
|
||||
|
|
@ -100,16 +105,12 @@ Host raspiblitz
|
|||
LocalForward 28183 localhost:28183
|
||||
```
|
||||
|
||||
### Download and Install the Prototype
|
||||
### Download and install the app
|
||||
|
||||
In short:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/joinmarket-webui/jm-web-client.git
|
||||
cd jm-web-client
|
||||
git clone https://github.com/joinmarket-webui/joinmarket-webui.git
|
||||
cd joinmarket-webui
|
||||
npm install && npm start
|
||||
```
|
||||
|
||||
In any case, if everything works, you should be greeted with the following screen, assuming you have a wallet set up in JoinMarket:
|
||||
|
||||

|
||||
|
|
|
|||
12
package-lock.json
generated
12
package-lock.json
generated
|
|
@ -1,12 +1,13 @@
|
|||
{
|
||||
"name": "joinmarket-web-ui",
|
||||
"version": "0.1.0",
|
||||
"name": "joinmarket-webui",
|
||||
"version": "0.0.1",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "joinmarket-web-ui",
|
||||
"version": "0.1.0",
|
||||
"name": "joinmarket-webui",
|
||||
"version": "0.0.1",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"serve": "13.0.2"
|
||||
},
|
||||
|
|
@ -27,6 +28,9 @@
|
|||
"react-router-dom": "^6.2.1",
|
||||
"react-scripts": "^5.0.0",
|
||||
"web-vitals": "^2.1.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@babel/code-frame": {
|
||||
|
|
|
|||
10
package.json
10
package.json
|
|
@ -1,7 +1,13 @@
|
|||
{
|
||||
"name": "joinmarket-web-ui",
|
||||
"version": "0.1.0",
|
||||
"name": "joinmarket-webui",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"description": "JoinMarket Web UI",
|
||||
"repository": "git@github.com:joinmarket-webui/joinmarket-webui.git",
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=14.0.0"
|
||||
},
|
||||
"homepage": ".",
|
||||
"devDependencies": {
|
||||
"@ibunker/bitcoin-react": "^0.1.13-cd",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue