freeboard-leaflet-realtime

Richard Wen
rrwen.dev@gmail.com

Freeboard plugin for real time Leaflet web maps

Install

1. Install git
2. Clone freeboard
3. Change into directory freeboard

git clone https://github.com/Freeboard/freeboard.git
cd freeboard

For the latest developer version, see Developer Install.

Usage

After cloning freeboard, edit head.js in freeboard/index.html to include the freeboard-leaflet-realtime plugin:

head.js(...,
    'https://cdn.rawgit.com/rrwen/freeboard-leaflet-realtime/b84f99f8/index.js',
    ...)

Open freeboard/index.html to use the new plugin.

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.

Developer Notes

Developer Install

Install from npm:

1. Install Node.js
2. Install freeboard-leaflet-realtime via npm

npm install --save freeboard-leaflet-realtime

Install the latest developer version with npm from github:

npm install git+https://github.com/rrwen/freeboard-leaflet-realtime

Install from git cloned source:

1. Ensure git is installed
2. Clone into current path
3. Install via npm

git clone https://github.com/rrwen/freeboard-leaflet-realtime
cd freeboard-leaflet-realtime
npm install

Upload to Github

1. Ensure git is installed
2. Inside the freeboard-leaflet-realtime folder, add all files and commit changes
3. Push to github

git add .
git commit -a -m "Generic update"
git push

Upload to npm

1. Update the version in package.json
2. Login to npm
3. Publish to npm

npm login
npm publish

Implementation

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

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