-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
40 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,44 @@ | ||
# notif-engine | ||
|
||
## Turning on the notif-engine consumer process | ||
``` | ||
SESHOST="<amazonses_host>" SESPORT=<amazonses_port> SESISSECURE=<amazonses_is_secure_flag_integer_0_or_1> SESUSER="<amazonses_user>" SESPASS="<amazonses_password>" OSAPPID="<onesignal_appid>" OSAPIKEY="<onesignal_apikey>" MONGOURL="<your_mongourl_or_mongoclusterurls>" node consumer/app.js | ||
- [Features](#features) | ||
- [How to use](#how-to-use) | ||
- [Contributing](#contributing) | ||
- [Need help? Found a bug?](#need-help-found-a-bug) | ||
- [Vote of thanks](#vote-of-thanks) | ||
|
||
## Features | ||
|
||
* **Easy notification storage (multiple channel support)** — Store `email` | `push` before sending them. Currently supports MongoDB as the data store. | ||
|
||
* **Easy notification sending** — Send `email` | `push` through supported providers and update the status in your data store. Currently supports [Amazon Simple Email Service](https://aws.amazon.com/ses/) for emails and [OneSignal](https://onesignal.com/) for push notifications. | ||
|
||
* **MIT license** — Use it like you want. | ||
|
||
## How to use | ||
|
||
### Turning on the notif-engine consumer process | ||
|
||
> | ||
>SESHOST="<amazonses_host>" SESPORT=<amazonses_port> SESISSECURE=<amazonses_is_secure_flag_integer_0_or_1> SESUSER="<amazonses_user>" SESPASS="<amazonses_password>" OSAPPID="<onesignal_appid>" OSAPIKEY="<onesignal_apikey>" MONGOURL="<your_mongourl_or_mongoclusterurls>" node consumer/app.js | ||
> | ||
## Contributing | ||
|
||
And, of course, feel free to submit pull requests with bug fixes/changes/feature additions. All contributions are always welcomed! | ||
|
||
To get started: [fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. | ||
|
||
```shell | ||
$ git clone git@github.com:[YOUR_USERNAME]/notif-engine.git && cd notif-engine && npm install | ||
``` | ||
|
||
## Thanks | ||
- [Sindre Sorhus](https://github.com/sindresorhus) for the amazing module [np](https://www.npmjs.com/package/np) | ||
Then add, commit, push to your repo and finally send a [pull request](https://help.github.com/articles/creating-a-pull-request/) | ||
|
||
|
||
## Need Help? Found a bug? | ||
|
||
[Submit an issue](https://github.com/CoffeeBeansLabs/notif-engine/issues) if you need any help. | ||
|
||
|
||
## Vote of thanks | ||
- [Sindre Sorhus](https://github.com/sindresorhus) for the amazing module [np](https://www.npmjs.com/package/np). This module has been of immense help, making ```npm publish``` easy and blazing fast. |