https://github.com/soywod/overflood
A notifier platform.
https://github.com/soywod/overflood
create-react-app notification react react-hook typescript
Last synced: 8 months ago
JSON representation
A notifier platform.
- Host: GitHub
- URL: https://github.com/soywod/overflood
- Owner: soywod
- License: mit
- Created: 2019-04-23T20:31:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-24T15:05:26.000Z (over 6 years ago)
- Last Synced: 2024-12-15T22:29:09.809Z (10 months ago)
- Topics: create-react-app, notification, react, react-hook, typescript
- Language: TypeScript
- Homepage: https://overflood.soywod.me
- Size: 223 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
- [Stack Overflow](https://stackoverflow.com/): get notified when a new question is posted
- [Codeur.com](https://www.codeur.com/): get notified when a new project is posted
Want to add a new provider? Any
[suggestion](https://github.com/soywod/overflood/issues/new) or
[pull-request](https://github.com/soywod/overflood/compare) is welcomed!
## Development
Install:
```bash
git clone https://github.com/soywod/overflood.git
cd overflood
yarn install
```
Then start the web server:
```bash
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](https://github.com/soywod/overflood/issues/new), or propose a
pull-request.
Any new provider should be placed in `/src/providers`, and should follow this
type:
```typescript
type Provider = {
name: string
description: string
form: ComponentType
subscribe: (data: Map) => void
unsubscribe: () => void
}
```