https://github.com/nextorigin/godot2-dash

An HTTP dashboard for Godot2.
https://github.com/nextorigin/godot2-dash

analytics dashboard event-processing event-processor event-sourcing eventsourcing nodejs push-streams reactive realtime riemann server-sent-events statistics stream-processing stream-processing-engine stream-processor streaming streams streams3 websockets

Last synced: 4 months ago
JSON representation

An HTTP dashboard for Godot2.

• Host: GitHub
• URL: https://github.com/nextorigin/godot2-dash
• Owner: nextorigin
• License: mit
• Fork: true (riemann/riemann-dash)
• Created: 2016-09-16T08:05:41.000Z (over 8 years ago)
• Default Branch: nextorigin
• Last Pushed: 2016-11-29T17:08:59.000Z (about 8 years ago)
• Last Synced: 2024-09-04T08:48:44.254Z (5 months ago)
• Topics: analytics, dashboard, event-processing, event-processor, event-sourcing, eventsourcing, nodejs, push-streams, reactive, realtime, riemann, server-sent-events, statistics, stream-processing, stream-processing-engine, stream-processor, streaming, streams, streams3, websockets
• Language: JavaScript
• Homepage:
• Size: 1.09 MB
• Stars: 16
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Godot2-Dash

[![Dependency Status][dependency]][david]

[![devDependency Status][dev-dependency]][david-dev]

[![Downloads][downloads]][npm]

A javascript, engine.io-powered dashboard for [Godot2][godot2]. A port of [riemann-dash][riemann-dash]

from ruby/sinatra to node.js.

[![NPM][npm-stats]][npm]

![godot2-dash screenshot](./docs/godot2-dash_Screen-Shot-2016-11-29.png?raw=true "godot2-dash example screenshot")

## Installation

```sh

npm install --save godot2-dash

```

## API

### dash.createServer(options)

Use this if you want to just create a dashboard server with minimal ceremony.

Takes an options hash with the following properties:

* mount: Where to mount the dashboard (defaults to `/`)

* config: File location for the config file (defaults to

  ./config.json )

Usage looks something like this:

```js

var godot = require('godot2'),

    dash = require('godot2-dash');

var dashboard = dash.createServer()

godot.createServer({

  type: 'tcp',

  reactors: [

    new dash.reactor(dashboard)

  ]

}).listen(1337);

dashboard.listen(1338);

```

#### dash.middleware(options)

Returns a middleware. Options are the same as those of `dash.createServer`. You

can use this if you want to add the godot dashboard to an existing middleware

stack without creating a new server.

#### dash.reactor(server)

Creates a new reactor. Pass in an http server to attach

engine.io to. You can use this in conjunction with `dash.middleware` to add the

dashboard to an existing middleware stack.

## License

MIT

  [godot2]: https://github.com/nextorigin/godot2

  [riemann-dash]: https://github.com/riemann/riemann-dash

  [dependency]: https://img.shields.io/david/nextorigin/godot2-dash.svg?style=flat-square

  [david]: https://david-dm.org/nextorigin/godot2-dash

  [dev-dependency]: https://img.shields.io/david/dev/nextorigin/godot2-dash.svg?style=flat-square

  [david-dev]: https://david-dm.org/nextorigin/godot2-dash?type=dev

  [downloads]: https://img.shields.io/npm/dm/godot2-dash.svg?style=flat-square

  [npm]: https://www.npmjs.org/package/godot2-dash

  [npm-stats]: https://nodei.co/npm/godot2-dash.png?downloads=true&downloadRank=true&stars=true