protect-dashboard

Protect Dashboard

A web dashboard for protect-api

Stack

react, react-dom, react-router, webpack, babel and friends... (subject to change)

Install

npm i
npm run build:clean
npm run build

Run

To start server:

npm run start

To start server with hot module reloading and error detection:

npm run hot

To run server in optimized (production) mode:

npm run optimized

After starting a server you should see Listening on http://127.0.0.1:9995 by default (both host interface and port are configurable).

Config

A users table can be defined as a map on the users key of the protectdashboard config. For example, if your .protectdashboardrc file looks like this:

{
  "port": 1337,
  "users": {
    "joe@example.com": "password1"
  },
  "api": {
    "connection": {
      "host": "protect-api.nowsecure.io"
    },
    "credentials": {
      "token": "XXX"
    }
  }
}

This will start the protect-dashboard server on port 1337 and only allow logins using for the user joe@example.com. Once logged in a websockets connection is made to a staging protect-api host (wss://protect-api.nowsecure.io) and assuming the "XXX" value is replaced with a valid token, your interface will be populated with staging data.

TODO:

Update this TODO list
Address all TODO's in the codebase
Properly style all charts

protect-dashboard