Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethersphere/bee-dashboard
An app which helps users to setup their Bee node and do actions like cash out cheques
https://github.com/ethersphere/bee-dashboard
bee decentralized-storage ethereum swarm
Last synced: 2 days ago
JSON representation
An app which helps users to setup their Bee node and do actions like cash out cheques
- Host: GitHub
- URL: https://github.com/ethersphere/bee-dashboard
- Owner: ethersphere
- License: bsd-3-clause
- Created: 2021-02-22T20:30:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T11:39:02.000Z (about 2 months ago)
- Last Synced: 2025-01-12T14:06:04.395Z (9 days ago)
- Topics: bee, decentralized-storage, ethereum, swarm
- Language: TypeScript
- Homepage: https://dashboard.ethswarm.org/
- Size: 39.4 MB
- Stars: 142
- Watchers: 19
- Forks: 53
- Open Issues: 69
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-swarm - Bee Dashboard - React project to troubleshoot and interact with your Bee node (Projects / UI)
README
# Bee Dashboard
[](https://swarm.ethereum.org/)
[](https://github.com/RichardLitt/standard-readme)
[](https://github.com/feross/standard)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard?ref=badge_shield)
> 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.**
Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the
[releases tab](https://github.com/ethersphere/bee-dashboard/releases).
| Node Setup | Upload Files | Download Content | Accounting | Settings |
| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ------------------------------------- |
|  |  |  |  |  |
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Terminal](#terminal)
- [Docker](#docker)
- [Contribute](#contribute)
- [Development](#development)
- [Maintainers](#maintainers)
- [License](#license)
## Install
Install globally with npm. We require Node.js's version of at least 12.x and npm v6.x (or yarn v2.x).
```sh
npm install -g @ethersphere/bee-dashboard
```
## Usage
:warning: 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](https://docs.ethswarm.org/docs/working-with-bee/configuration#configuring-bee-installed-using-a-package-manager)
### Terminal
To start use:
```sh
bee-dashboard
```
This should open the webpage on [`http://localhost:8080`](http://localhost:8080)
You can also define your own port with the `PORT` environment variable. E.g.
```sh
export PORT=3005
bee-dashboard
```
Will start the bee-dashboard on [`http://localhost:3005`](http://localhost:3005)
### Docker
To build Docker image and run it, execute the following from inside project directory:
```sh
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`](http://localhost:8080)
### Development
```sh
git clone [email protected]:ethersphere/bee-dashboard.git
cd bee-dashboard
npm i
npm start
```
The Bee Dashboard runs in development mode on [http://localhost:3031/](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:
```sh
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](https://github.com/ethersphere/bee-dashboard/issues) and take on one of them
- Help our tests reach 100% coverage!
- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or
want to give feedback
## Maintainers
- [Cafe137](https://github.com/Cafe137)
See what "Maintainer" means [here](https://github.com/ethersphere/repo-maintainer).
## License
[BSD-3-Clause](./LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard?ref=badge_large)