firewalletbrowser/README.md

114 lines
2.1 KiB
Markdown
Raw Normal View History

2023-12-28 11:10:28 +11:00
# FireWalletBrowser
## Installation
```bash
git clone https://github.com/Nathanwoodburn/firewalletbrowser.git
cd firewalletbrowser
python3 -m pip install -r requirements.txt
cp example.env .env
```
2024-01-29 15:48:36 +11:00
Edit .env to have your HSD api key.
If you have HSD runnning on a separate computer also add the IP here
## Usage
Make sure HSD is running then run the following commands:
On Linux:
```bash
python3 server.py
# Or for more verbose output
python3 main.py
```
On Windows:
```bash
2024-02-17 11:57:04 +11:00
python3 main.py
```
2024-01-29 15:42:54 +11:00
Then access the wallet at http://localhost:5000
Also available as a docker image:
To run using a HSD running directly on the host:
```bash
2024-01-29 15:48:36 +11:00
sudo docker run --network=host -e hsd_api=yourapikeyhere git.woodburn.au/nathanwoodburn/firewallet:latest
```
If you have HSD running on a different IP/container
```bash
sudo docker run -p 5000:5000 -e hsd_api=yourapikeyhere -e hsd_ip=hsdcontainer git.woodburn.au/nathanwoodburn/firewallet:latest
2024-01-29 16:00:22 +11:00
```
2024-02-04 15:08:24 +11:00
## Features
- Basic wallet functionality
2024-02-04 16:55:28 +11:00
- Create new wallet
- Import wallet from seed
2024-02-04 15:08:24 +11:00
- Send HNS
- Receive HNS
- Have multiple wallets
- View transactions
- View balance
- View wallet domains
- Domain management
- Transfer domains
- DNS Editor
- Renew domains
- Auctions
- Send open
- Send bid
- Send reveal
- Send redeem
- Download a list of all domains
- Resend all pending transactions
- Rescan
- Zap pending transactions
- View xPub
- Custom plugin support
2024-02-01 23:41:22 +11:00
## Themes
Set a theme in the .env file
**Available themes**
- dark-purple
- black
2024-01-29 16:00:22 +11:00
## Images
Login page
![Login page](assets/login.png)
Home page
![Home page](assets/home.png)
Transactions page
![Transactions page](assets/transactions.png)
Send page
![Send page](assets/send.png)
Transaction confirmation
![Confirmation page](assets/confirmation.png)
Receive page
![Receive page](assets/receive.png)
Settings page
![Settings page](assets/settings.png)
Domain page
![Domain page](assets/domain.png)
Domain management page
![Domain management page](assets/domainmanage.png)
DNS Editor page
![DNS Editor page](assets/dnseditor.png)
Auction page
![Auction page](assets/auction.png)