Retropex/umbrel-bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/umbrel-bitcoin.git synced 2025-05-12 19:20:49 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Remove incorrect development instructions

Browse Source
This commit is contained in:
Luke Childs 2022-06-30 17:09:47 +07:00 committed by GitHub
parent 0df7ccf768
commit 66c88969de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -28,39 +28,6 @@
This app can be installed in one click via the Umbrel App Store.
## Running locally for development
Make sure a [`bitcoind`](https://github.com/bitcoin/bitcoin) instance is running and available on the same machine.
### Step 1. Install dependencies
```sh
yarn
```
### Step 2. Set environment variables
Set the following environment variables directly or by placing them in `.env` file of project's root.
| Variable | Description | Default |
| ------------- | ------------- | ------------- |
| `PORT` | Port where the API should listen for requests | `3005` |
| `DEVICE_HOSTS` | Comma separated list of IPs or domain names to whitelist for CORS | `http://umbrel.local` |
| `BITCOIN_HOST` | IP or domain where `bitcoind` RPC is listening | `127.0.0.1` |
| `RPC_USER` | `bitcoind` RPC username | |
| `RPC_PASSWORD` | `bitcoind` RPC password | |
### Step 3. Build the web interface
```sh
yarn install:ui
yarn build:ui
```
### Step 4. Run
```sh
yarn start
```
You can access the app interface by visiting `http://localhost:8080/`
---
## Contributing