项目作者: soywod

项目描述 :
A notifier platform.
高级语言: TypeScript
项目地址: git://github.com/soywod/overflood.git
创建时间: 2019-04-23T20:31:20Z
项目社区:https://github.com/soywod/overflood

开源协议:MIT License

下载


Overflood

A notifier platform.

Introduction

Overflood is an aggregation of providers. You can choose which provider you
want to subscribe to, and you will receive notifications on new content.

Providers available

Want to add a new provider? Any
suggestion or
pull-request is welcomed!

Development

Install:

  1. git clone https://github.com/soywod/overflood.git
  2. cd overflood
  3. yarn install

Then start the web server:

  1. yarn start

The web app is be available at http://localhost:3000.

Propose a new provider

You can either suggest one in the issues
section
, or propose a
pull-request.

Any new provider should be placed in /src/providers, and should follow this
type:

  1. type Provider = {
  2. name: string
  3. description: string
  4. form: ComponentType
  5. subscribe: (data: Map<string, string>) => void
  6. unsubscribe: () => void
  7. }