Cafe137
ecaf2054fc
* feat: add light node upgrade * refactor: improve upgrade page * feat: pretty print xdai and add xbzz faucets * feat: display xBZZ balance (#312) * refactor: change rpc provider * fix: remove version alert * fix: load really xBZZ balance instead of xDAI (#314) * feat: add bee desktop api key support * chore: remove dead code * chore: revert useless change * refactor: extract desktop utils module (#339) * refactor: extract desktop utils module * fix: add 0x prefix if it missing from address * refactor: extract BalanceProvider * fix: remove double finally * fix: remove token fallbacks * fix: reuse address and handle balance errors * chore: disable eslint for any * refactor: remove upgrade page * refactor: cleanup, debounce and axios * refactor: change fetch to axios * chore: remove dead code * chore: revert import ordering * refactor: use axios instead of fetch * refactor: use token instead of string Co-authored-by: Cafe137 <aron@aronsoos.com> Co-authored-by: Vojtech Simetka <vojtech@simetka.cz>
Bee Dashboard
An app which helps users to setup their Bee node and do actions like cash out cheques, upload and download files or manage your postage stamps.
Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.
This project is intended to be used with Bee version 1.5.1-d0a77598. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the official Discord and by keeping an eye on the releases tab.
| Node Setup | Upload Files | Download Content | Accounting | Postage Stamps |
|---|---|---|---|---|
 |
 |
 |
 |
 |
Table of Contents
Install
Install globally with npm. We require Node.js's version of at least 12.x and npm v6.x (or yarn v2.x).
npm install -g @ethersphere/bee-dashboard
Usage
⚠️ To successfully connect to the Bee node, you will need to enable the Debug API and CORS. You can do so by
setting cors-allowed-origins: ['*'] and debug-api-enable: true in the Bee config file and then restart the Bee node.
To see where the config file is, consult the
official Bee documentation
Terminal
To start use:
bee-dashboard
This should open the webpage on http://localhost:8080
Docker
To build Docker image and run it, execute the following from inside project directory:
docker build . -t bee-dashboard
docker run --rm -p 127.0.0.1:8080:8080 bee-dashboard
Bee dashboard is now available on http://localhost:8080
Development
git clone git@github.com:ethersphere/bee-dashboard.git
cd bee-dashboard
npm i
npm start
The Bee Dashboard runs in development mode on http://localhost:3031/
Setting the
REACT_APP_DEV_MODE=1environment variable, or opening Bee Dashboard with the query string?devMode=1loosens some checks. This makes it possible to develop Bee Dashboard without having connected peers and chequebook properly set up, effectively supporting the dev mode of Bee itself.
Contribute
There are some ways you can make this module better:
- Consult our open issues and take on one of them
- Help our tests reach 100% coverage!
- Join us in our Discord chat in the #develop-on-swarm channel if you have questions or want to give feedback
Maintainers
See what "Maintainer" means here.
License
