Mirko Da Corte
aab0462047
* feat: added Dockerfile (#72) * fix: applying requested fixes on Dockerfile * fix: updated exposed port on Dockerfile chore: updated readme with docker instructions * Update README.md Co-authored-by: nugaon <50576770+nugaon@users.noreply.github.com> * fix: fixed codeblock in readme Co-authored-by: nugaon <50576770+nugaon@users.noreply.github.com>
73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
# Bee Dashboard
|
|
|
|
[](https://swarm.ethereum.org/)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://github.com/feross/standard)
|
|
|
|
|
|
|
|
> An app which helps users to setup their Bee node and do actions like cash out cheques.
|
|
|
|
**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.**
|
|
|
|
|
|
|
|
| Node Setup | Browse & Upload Files | Accounting | Peers | Settings |
|
|
|-------|---------|-------|----------|------|
|
|
|  |  |  |  |  |
|
|
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install -g @ethersphere/bee-dashboard
|
|
$ bee-dashboard
|
|
```
|
|
|
|
## Development
|
|
|
|
```sh
|
|
git clone git@github.com:ethersphere/bee-dashboard.git
|
|
|
|
cd bee-dashboard
|
|
|
|
npm ci
|
|
npm run build
|
|
npm run serve
|
|
```
|
|
|
|
You can now access Bee Dashboard on [http://localhost:8080/](http://localhost:8080/)
|
|
|
|
## 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
|
|
```
|
|
|
|
## 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 [Mattermost chat](https://beehive.ethswarm.org/swarm/channels/swarm-javascript) if you have questions or want to give feedback
|
|
|
|
## Maintainers
|
|
|
|
- [nugaon](https://github.com/nugaon)
|
|
- [vojtechsimetka](https://github.com/vojtechsimetka)
|
|
|
|
## License
|
|
|
|
[BSD-3-Clause](./LICENSE)
|