Skip to content

soywod/overflood

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

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

Then start the web server:

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:

type Provider = {
  name: string
  description: string
  form: ComponentType
  subscribe: (data: Map<string, string>) => void
  unsubscribe: () => void
}