{"id":13588594,"url":"https://github.com/ethersphere/bee-dashboard","last_synced_at":"2025-05-16T05:04:32.457Z","repository":{"id":36950403,"uuid":"341328858","full_name":"ethersphere/bee-dashboard","owner":"ethersphere","description":"An app which helps users to setup their Bee node and do actions like cash out cheques","archived":false,"fork":false,"pushed_at":"2025-03-12T11:38:23.000Z","size":41806,"stargazers_count":143,"open_issues_count":71,"forks_count":55,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-09T12:51:22.459Z","etag":null,"topics":["bee","decentralized-storage","ethereum","swarm"],"latest_commit_sha":null,"homepage":"https://dashboard.ethswarm.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersphere.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-22T20:30:40.000Z","updated_at":"2025-05-06T22:12:09.000Z","dependencies_parsed_at":"2023-02-10T23:15:52.021Z","dependency_job_id":"09edec77-bf4e-497f-b10b-90a4ec658529","html_url":"https://github.com/ethersphere/bee-dashboard","commit_stats":{"total_commits":351,"total_committers":20,"mean_commits":17.55,"dds":0.5897435897435898,"last_synced_commit":"e01d9fe3d7e3dfb6f7e36322251a098d6ed9ff98"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/bee-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471060,"owners_count":22076585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bee","decentralized-storage","ethereum","swarm"],"created_at":"2024-08-01T15:06:48.627Z","updated_at":"2025-05-16T05:04:32.441Z","avatar_url":"https://github.com/ethersphere.png","language":"TypeScript","readme":"# Bee Dashboard\n\n[![](https://img.shields.io/badge/made%20by-Swarm-blue.svg?style=flat-square)](https://swarm.ethereum.org/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard?ref=badge_shield)\n![](https://img.shields.io/badge/npm-%3E%3D6.9.0-orange.svg?style=flat-square)\n![](https://img.shields.io/badge/Node.js-%3E%3D14.0.0-orange.svg?style=flat-square)\n\n\u003e An app which helps users to setup their Bee node and do actions like cash out cheques, upload and download files or\n\u003e manage your postage stamps.\n\n**Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and\nworking. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**\n\nStay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the\n[releases tab](https://github.com/ethersphere/bee-dashboard/releases).\n\n![Status page](/ui_samples/info.png)\n\n| Node Setup                           | Upload Files                           | Download Content                           | Accounting                                | Settings                              |\n| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ------------------------------------- |\n| ![Setup](/ui_samples/node_setup.png) | ![Upload](/ui_samples/file_upload.png) | ![Download](/ui_samples/file_download.png) | ![Accounting](/ui_samples/accounting.png) | ![Settings](/ui_samples/settings.png) |\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n  - [Terminal](#terminal)\n  - [Docker](#docker)\n- [Contribute](#contribute)\n- [Development](#development)\n- [Maintainers](#maintainers)\n- [License](#license)\n\n## Install\n\nInstall globally with npm. We require Node.js's version of at least 12.x and npm v6.x (or yarn v2.x).\n\n```sh\nnpm install -g @ethersphere/bee-dashboard\n```\n\n## Usage\n\n:warning: To successfully connect to the Bee node, you will need to enable CORS. You can do so by setting\n`cors-allowed-origins: ['*']` in the Bee config file and then restart the Bee node. To see where the config file is,\nconsult the\n[official Bee documentation](https://docs.ethswarm.org/docs/working-with-bee/configuration#configuring-bee-installed-using-a-package-manager)\n\n### Terminal\n\nTo start use:\n\n```sh\nbee-dashboard\n```\n\nThis should open the webpage on [`http://localhost:8080`](http://localhost:8080)\n\nYou can also define your own port with the `PORT` environment variable. E.g.\n\n```sh\nexport PORT=3005\nbee-dashboard\n```\n\nWill start the bee-dashboard on [`http://localhost:3005`](http://localhost:3005)\n\n### Docker\n\nTo build Docker image and run it, execute the following from inside project directory:\n\n```sh\ndocker build . -t bee-dashboard\ndocker run --rm -p 127.0.0.1:8080:8080 bee-dashboard\n```\n\nBee dashboard is now available on [`http://localhost:8080`](http://localhost:8080)\n\n### Development\n\n```sh\ngit clone git@github.com:ethersphere/bee-dashboard.git\n\ncd  bee-dashboard\n\nnpm i\n\nnpm start\n```\n\nThe Bee Dashboard runs in development mode on [http://localhost:3031/](http://localhost:3031/)\n\n#### Environmental variables\n\nThe CRA supports to specify \"environmental variables\" during build time which are then hardcoded into the served static\nfiles. We support following variables:\n\n- `REACT_APP_BEE_DESKTOP_ENABLED` (`boolean`) that toggles if the Dashboard is in Desktop mode or not.\n- `REACT_APP_BEE_DESKTOP_URL` (`string`) defines custom URL where the Desktop API is expected. By default, it is same\n  origin under which the Dashboard is served.\n- `REACT_APP_BEE_HOST` (`string`) defines custom Bee API URL to be used as default one. By default, the\n  `http://localhost:1633` is used.\n- `REACT_APP_DEFAULT_RPC_URL` (`string`) defines the default RPC provider URL. Be aware, that his only configures the\n  default value. The user can override this in Settings, which is then persisted in local store and has priority over\n  the value set in this env. variable. By default `https://xdai.fairdatasociety.org` is used.\n\n#### Swarm Desktop development\n\nIf you want to develop Bee Dashboard in the Swarm Desktop mode, then spin up `swarm-desktop` to the point where Desktop\nis initialized (eq. the splash screen disappear) and:\n\n```sh\necho \"REACT_APP_BEE_DESKTOP_URL=http://localhost:3054\nREACT_APP_BEE_DESKTOP_ENABLED=true\" \u003e .env.development.local\n\nnpm start\nnpm run desktop # This will inject the API key to the Dashboard\n```\n\n## Contribute\n\nThere are some ways you can make this module better:\n\n- Consult our [open issues](https://github.com/ethersphere/bee-dashboard/issues) and take on one of them\n- Help our tests reach 100% coverage!\n- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or\n  want to give feedback\n\n## Maintainers\n\n- [Cafe137](https://github.com/Cafe137)\n\nSee what \"Maintainer\" means [here](https://github.com/ethersphere/repo-maintainer).\n\n## License\n\n[BSD-3-Clause](./LICENSE)\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard?ref=badge_large)\n","funding_links":[],"categories":["TypeScript","Projects"],"sub_categories":["UI"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbee-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fbee-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbee-dashboard/lists"}