Update README.md

This commit is contained in:
Afri Schoedon 2018-12-01 01:19:45 +01:00 committed by GitHub
parent 1f6327d641
commit f6416f3717
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,8 +1,8 @@
Ethereum Network Stats
Ethereum POA-Network Stats
============
[![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url]
This is a visual interface for tracking ethereum 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 [eth-net-intelligence-api](https://github.com/cubedro/eth-net-intelligence-api).
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).
![Screenshot](https://raw.githubusercontent.com/cubedro/eth-netstats/master/src/images/screenshot.jpg?v=0.0.6 "Screenshot")
@ -16,40 +16,27 @@ Make sure you have node.js and npm installed.
Clone the repository and install the dependencies
```bash
git clone https://github.com/cubedro/eth-netstats
cd eth-netstats
git clone https://github.com/goerli/netstats-server
cd netstats-server
npm install
sudo npm install -g grunt-cli
```
##Build the resources
NetStats features two versions: the full version and the lite version. In order to build the static files you have to run grunt tasks which will generate dist or dist-lite 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.
To build the full version run
```bash
grunt
```
To build the lite version run
```bash
grunt lite
```
If you want to build both versions run
```bash
grunt all
```
##Run
```bash
npm start
WS_SECRET="asdf" npm start
```
see the interface at http://localhost:3000
[travis-image]: https://travis-ci.org/cubedro/eth-netstats.svg
[travis-url]: https://travis-ci.org/cubedro/eth-netstats
[dep-image]: https://david-dm.org/cubedro/eth-netstats.svg
[dep-url]: https://david-dm.org/cubedro/eth-netstats
[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