Important: this module is now deprecated, please use the corresponding package in the weacast monorepo.

weacast-alert

Forecast alert plugin for Weacast

Installation

npm install weacast-alert --save
// Or with Yarn
yarn add weacast-alert

Documentation

The Weacast docs are loaded with awesome stuff and tell you everything you need to know about using and configuring Weacast. Some details about this plugin can be found here.

Complete Example

Here's an example of a Weacast server that uses weacast-alert.

import alertPlugin from 'weacast-alert'

module.exports = function() {
  const app = this
  
  // Set up our plugin services
  app.configure(alertPlugin)
}

Development

While it is a WIP and not yet pushed to NPM, or when developing this plugin, please clone this repository and use npm link:

// Clone and link the plugin
git clone https://github.com/weacast/weacast-alert.git
cd weacast-alert
npm link
// Clone and link plugin to weacast server
cd ..
git clone https://github.com/weacast/weacast.git
cd weacast
cd api
npm link weacast-alert

As this module also depends on weacast-core and weacast-probe you have to do the same thing for it.

License

Copyright (c) 2017

Licensed under the MIT license.