Giter VIP home page Giter VIP logo

notifier's Introduction

Notifier

Description

Notifier is a NodeJS application that uses plugins to fetch data from the internet and push it to whatever platform you wish!

Requirements:

  • NodeJS (Developed using latest LTS, 16.13.0)
  • Install required packages with npm install

Writing plugins:

manifest.json

Each plugin directory must contain a manifest.json file in the following format:

{
	"name": "Plugin Name",
	"type": "source|destination",
	"main": "MainScript.js"
}

Source Plugins

Source plugins must export a check function in the following format:

exports.check = async function(pluginManager)
{
	// Do your checking
	// ...
	
	// Push to queue
	pluginManager.pushToQueue({
		source: "My Plugin Name",
		message: "Some message"
	});
}

Destination Plugins

Destination plugins must export a push function in the following format:

exports.push = async function(activityQueue)
{
	// Push the activity to wherever you want
}

notifier's People

Contributors

jacobsweeten avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.