@ethersphere/bee-dashboard
TypeScript icon, indicating that this package has built-in type declarations

0.28.0 • Public • Published

Bee Dashboard

standard-readme compliant js-standard-style FOSSA Status

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.12.0-88c1d236**. 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.

Status page

Node Setup Upload Files Download Content Accounting Settings
Setup Upload Download Accounting Settings

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 CORS. You can do so by setting cors-allowed-origins: ['*'] 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

You can also define your own port with the PORT environment variable. E.g.

export PORT=3005
bee-dashboard

Will start the bee-dashboard on http://localhost:3005

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/

Environmental variables

The CRA supports to specify "environmental variables" during build time which are then hardcoded into the served static files. We support following variables:

  • REACT_APP_BEE_DESKTOP_ENABLED (boolean) that toggles if the Dashboard is in Desktop mode or not.
  • REACT_APP_BEE_DESKTOP_URL (string) defines custom URL where the Desktop API is expected. By default, it is same origin under which the Dashboard is served.
  • REACT_APP_BEE_HOST (string) defines custom Bee API URL to be used as default one. By default, the http://localhost:1633 is used.
  • REACT_APP_DEFAULT_RPC_URL (string) defines the default RPC provider URL. Be aware, that his only configures the default value. The user can override this in Settings, which is then persisted in local store and has priority over the value set in this env. variable. By default https://xdai.fairdatasociety.org is used.

Swarm Desktop development

If you want to develop Bee Dashboard in the Swarm Desktop mode, then spin up swarm-desktop to the point where Desktop is initialized (eq. the splash screen disappear) and:

echo "REACT_APP_BEE_DESKTOP_URL=http://localhost:3054
REACT_APP_BEE_DESKTOP_ENABLED=true" > .env.development.local

npm start
npm run desktop # This will inject the API key to the Dashboard

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

BSD-3-Clause

FOSSA Status

Package Sidebar

Install

npm i @ethersphere/bee-dashboard

Homepage

.

Weekly Downloads

70

Version

0.28.0

License

BSD-3-Clause

Unpacked Size

23.8 MB

Total Files

173

Last publish

Collaborators

  • ethersphereowner
  • bee-worker