GitHub - notifirehq/notifire: 🚀 The ultimate library for managing multi-channel...
source link: https://github.com/notifirehq/notifire
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Notification management simplified.
Explore the docs »
Report Bug
·
Request Feature
·
Read our blog
Why
Building a notification system is hard, at first it seems like just sending an email but in reality it's just the beginning. In today's world users expect multi channel communication experience over email, sms, push, direct and more... An ever growing list of providers are popping up each day, and notifications are spread around the code. Notifire's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and it's users.
Features
Single API for all messaging providers (Email, SMS, Push, Direct)
Easily manage notification over multiple channels
Equipped with a templating engine for advanced layouts and designs
Built-in protection for missing variables
Easy to set up and integrate- Written in TypeScript with predictable static types.
Community driven
Install
npm install @notifire/core
yarn add @notifire/core
Usage
import { Notifire, ChannelTypeEnum } from '@notifire/core';
import { SendgridEmailProvider } from '@notifire/sendgrid';
const notifire = new Notifire();
await notifire.registerProvider(
new SendgridEmailProvider({
apiKey: process.env.SENDGRID_API_KEY,
from: '[email protected]'
})
);
const passwordResetTemplate = await notifire.registerTemplate({
id: 'password-reset',
messages: [
{
subject: 'Your password reset request',
channel: ChannelTypeEnum.EMAIL,
template: `
Hi {{firstName}}!
To reset your password click <a href="{{resetLink}}">here.</a>
{{#if organization}}
<img src="{{organization.logo}}" />
{{/if}}
`
},
]
});
await notifire.trigger('<REPLACE_WITH_EVENT_NAME>', {
$user_id: "<USER IDENTIFIER>",
$email: "[email protected]",
firstName: "John",
lastName: "Doe",
organization: {
logo: 'https://evilcorp.com/logo.png'
}
});Providers
Notifire provides a single API to manage providers across multiple channels with a single to use interface.
Email
SMS
Push
- Pushwoosh
Links
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK