freeboard-leaflet-realtime

Richard Wen
rrwen.dev@gmail.com

* Demo

Freeboard plugin for real time Leaflet web maps


Install

1. Install Node.js and git
2. Clone freeboard and change directory
3. Install freeboard-leaflet-realtime via npm

``
git clone https://github.com/Freeboard/freeboard.git
cd freeboard
npm install --save freeboard-leaflet-realtime
`

For the latest developer version, see Developer Install.

Usage

Step 1. After cloning freeboard and installing freeboard-leaflet-realtime, you should have the following files:

* freeboard/index.html
* freeboard/node_modules/freeboard-leaflet-realtime/index.js

Step 2. Edit the head.js() function in freeboard/index.html to add the plugin:

`javascript
head.js(
...,
'node_modules/freeboard-leaflet-realtime/index.js',
...
);
`

If you require a Content Delivery Network (CDN) link, you may use the following rawgit CDN without an npm install:

`javascript
head.js(
...,
'https://cdn.rawgit.com/rrwen/freeboard-leaflet-realtime/7d1cc80f/index.js',
...
);
`

Step 3. Open freeboard/index.html to use the added plugin interactively.

Contributions

1. Reports for issues and suggestions can be made using the issue submission interface.
2. Code contributions are submitted via pull requests

See CONTRIBUTING.md for more details.

Implementation

The module freeboard-leaflet-realtime uses the following npm packages for its implementation:

npm | Purpose
--- | ---
freeboard | Base dashboard that accepts this plugin
leaflet | Web map providing tiles and layers
leaflet-realtime | Real time layers for leaflet


`
freeboard <-- base dashboard
|
leaflet <-- Add leaflet webmap to dashboard pane
|
leaflet-realtime <-- Add realtime layer to leaflet
``

For more information, see Developer Notes.