Skip to content
forked from novuhq/novu

πŸš€ The ultimate library for managing multi-channel notifications with a single API.

License

Notifications You must be signed in to change notification settings

painotpi/notifire

Β 
Β 

Repository files navigation

Notification management simplified.

The ultimate library for managing multi-channel notifications with a single API.


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: 'sender@mail.com'
  })
);

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: "test@email.com",
  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

About

πŸš€ The ultimate library for managing multi-channel notifications with a single API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 87.2%
  • Raku 5.8%
  • JavaScript 3.0%
  • Perl 2.1%
  • Dockerfile 1.9%