ethstats-server/README.md

43 lines
1.3 KiB
Markdown
Raw Normal View History

2018-12-01 01:19:45 +01:00
Ethereum POA-Network Stats
2015-02-25 22:28:20 +01:00
============
[![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url]
2015-02-04 11:37:56 +01:00
2018-12-01 01:19:45 +01:00
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).
2015-02-26 19:33:57 +01:00
2015-05-30 17:05:46 +02:00
![Screenshot](https://raw.githubusercontent.com/cubedro/eth-netstats/master/src/images/screenshot.jpg?v=0.0.6 "Screenshot")
## Prerequisite
* node
* npm
## Installation
2015-02-26 20:06:51 +01:00
Make sure you have node.js and npm installed.
2015-02-04 11:37:56 +01:00
2015-02-26 20:06:51 +01:00
Clone the repository and install the dependencies
2015-02-04 11:37:56 +01:00
2015-04-06 06:26:44 +02:00
```bash
2018-12-01 01:19:45 +01:00
git clone https://github.com/goerli/netstats-server
cd netstats-server
2015-02-26 20:06:51 +01:00
npm install
2015-08-01 17:21:53 +02:00
sudo npm install -g grunt-cli
2015-02-04 11:37:56 +01:00
```
2017-04-16 21:38:29 +02:00
## Build the resources
2018-12-01 01:19:45 +01:00
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.
2015-07-27 15:37:42 +02:00
```bash
grunt
```
2017-04-16 21:38:29 +02:00
## Run
2015-02-04 11:37:56 +01:00
2015-04-06 06:26:44 +02:00
```bash
2018-12-01 01:19:45 +01:00
WS_SECRET="asdf" npm start
2015-02-04 11:37:56 +01:00
```
see the interface at http://localhost:3000
2015-02-25 22:28:20 +01:00
2018-12-01 01:19:45 +01:00
[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