Skip to content

Commit

Permalink
Readme changes to reflect RSK usage
Browse files Browse the repository at this point in the history
  • Loading branch information
martinmedina authored Jan 15, 2019
1 parent d2ef5c8 commit f700eda
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
RSK Network Stats
==================
RSK Network Stats | Backend
===========================

This is a visual interface for tracking rsk status. It uses WebSockets to receive stats from running nodes and output them through an angular interface. It is the front-end implementation for [network-intelligence-api](https://github.com/cubedro/eth-net-intelligence-api).
This component exposes a websockets interface to receive and aggregate information from RSK network nodes.
Information is then provided through a websockets service and used by the RSK Network Stats frontend component. This component outputs all the data through vue interace.

There is also an angular front end interface in this code that works but is currently not being used to output information.

Note. Information received from network nodes is provided by a service called `stats agent` which is responsible for interacting with an RSK node via web3 to extract relevant information.

![Screenshot](https://github.com/rootstock/stats/blob/master/src/images/screenshot.png?raw=true "Screenshot")

## Prerequisite
* node
Expand All @@ -15,14 +19,14 @@ Make sure you have node.js and npm installed.
Clone the repository and install the dependencies

```bash
git clone https://github.com/rootstock/stats.git
git clone https://github.com/rsksmart/stats.git
cd stats
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.
## Build the resources
There are 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.


To build the full version run
Expand All @@ -40,13 +44,13 @@ If you want to build both versions run
grunt all
```

##Run
## Run

```bash
npm start
```

see the interface at http://localhost:3000
See the interface at http://localhost:3000


To update geoip-lite db run
Expand Down

0 comments on commit f700eda

Please sign in to comment.