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

docs: update readme

This commit is contained in:
5chdn 2018-12-03 20:50:05 +01:00
parent 99b634efa3
commit 32057b15c8
No known key found for this signature in database
GPG Key ID: 1A40871B597F5F80
2 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Gruntfile.js
View File

@ -169,7 +169,6 @@ module.exports = function(grunt) {
}
},
uglify: {
app: {
options: {
mangle: false,

36
README.md
View File

@ -1,44 +1,44 @@
Ethereum Network Stats with POA support
============
Ethereum Network Stats with POA and POW support
===============================================
[![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url]
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).
This is a visual interface for tracking proof-of-work ("mainnet") and proof-of-authority ("testnet") 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/images/screenshot-v0.1.0.png "Screenshot")
### Prerequisite
#### Prerequisite
* node
* npm
### Installation
#### Installation
Make sure you have node.js and npm installed.
Clone the repository and install the dependencies
Clone the repository and install the dependencies:
```bash
git clone https://github.com/goerli/netstats-server
cd netstats-server
git clone https://github.com/goerli/ethstats-server
cd ethstats-server
npm install
sudo npm install -g grunt-cli
```
### Build
#### 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.
```bash
grunt poa
```
### Run
#### Run
Start a node process and pass the websocket secret to it.
```bash
WS_SECRET="asdf" npm start
```
see the interface at http://localhost:3000
Find the interface at http://localhost:3000
## Proof-of-Work
## Proof-of-Work (Legacy)
![Screenshot](src/images/screenshot-v0.0.6.png "Screenshot")
@ -49,9 +49,9 @@ 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-url]: https://travis-ci.org/goerli/netstats-server
[dep-image]: https://david-dm.org/goerli/netstats-server.svg
[dep-url]: https://david-dm.org/goerli/netstats-server
[travis-image]: https://travis-ci.org/goerli/ethstats-server.svg
[travis-url]: https://travis-ci.org/goerli/ethstats-server
[dep-image]: https://david-dm.org/goerli/ethstats-server.svg
[dep-url]: https://david-dm.org/goerli/ethstats-server