grassrootseconomics
/
ethstats-server
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update README for poa and pow

This commit is contained in:
5chdn 2018-12-03 14:16:26 +01:00
parent d5fe3c3efe
commit 539b1a7aed
No known key found for this signature in database
GPG Key ID: 1A40871B597F5F80
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,16 +1,18 @@
Ethereum POA-Network Stats Ethereum Network Stats with POA support
============ ============
[![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url] [![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url]
This is a visual interface for tracking proof-of-authority network status. It uses WebSockets to receive stats from running nodes and output them through an angular interface. It is the front-end implementation for [netstats-client](https://github.com/goerli/netstats-client). This is a visual interface for tracking proof-of-work and proof-of-authority network status. It uses WebSockets to receive stats from running nodes and output them through an angular interface. It is the front-end implementation for [netstats-client](https://github.com/goerli/netstats-client).
## Proof-of-Authority
![Screenshot](src/poa/images/screenshot-v0.1.0.png "Screenshot") ![Screenshot](src/poa/images/screenshot-v0.1.0.png "Screenshot")
## Prerequisite ### Prerequisite
* node * node
* npm * npm
## Installation ### Installation
Make sure you have node.js and npm installed. Make sure you have node.js and npm installed.
Clone the repository and install the dependencies Clone the repository and install the dependencies
@ -22,20 +24,33 @@ npm install
sudo npm install -g grunt-cli sudo npm install -g grunt-cli
``` ```
## Build the resources ### Build
In order to build the static files you have to run grunt tasks which will generate dist directories containing the js and css files, fonts and images. In order to build the static files you have to run grunt tasks which will generate dist directories containing the js and css files, fonts and images.
```bash ```bash
grunt grunt poa
``` ```
## Run ### Run
```bash ```bash
WS_SECRET="asdf" npm start WS_SECRET="asdf" npm start
``` ```
see the interface at http://localhost:3000 see the interface at http://localhost:3000
## Proof-of-Work
![Screenshot](src/poa/images/screenshot-v0.0.6.png "Screenshot")
Same as above, just run the `pow` build task in Grunt.
```bash
grunt pow
WS_SECRET="asdf" npm start
```
see the interface at http://localhost:3000
[travis-image]: https://travis-ci.org/goerli/netstats-server.svg [travis-image]: https://travis-ci.org/goerli/netstats-server.svg
[travis-url]: https://travis-ci.org/goerli/netstats-server [travis-url]: https://travis-ci.org/goerli/netstats-server
[dep-image]: https://david-dm.org/goerli/netstats-server.svg [dep-image]: https://david-dm.org/goerli/netstats-server.svg