2

GitHub - novuhq/novu: 🚀 The open-source notifications infrastructure. A fully-fe...

 1 year ago
source link: https://github.com/novuhq/novu
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.

Logo Light

Notification management simplified.

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

Explore the docs »

Report Bug · Request Feature · Join Our Discord · Roadmap · Twitter

star 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. Novu's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and it's users.

sparkles Features

  • rainbow Single API for all messaging providers (Email, SMS, Push, Direct)
  • nail_care Easily manage notification over multiple channels
  • rocket Equipped with a CMS for advanced layouts and design management
  • shield Built-in protection for missing variables (Coming Soon)
  • package Easy to set up and integrate
  • shield Debug and analyze multi channel messages in a single dashboard
  • package Embeddable notification center with real-time updates
  • man_technologist Community driven

rocket Getting Started

We are excited to launch the complete Novu API and admin panel. Want to give it a test before the official release? here is how:

npx novu init

After setting up your account using the cloud or docker version you can trigger the API using the @novu/node package.

npm install @novu/node
import { Novu } from '@novu/node';

const novu = new Novu(process.env.NOVU_API_KEY);

await novu.trigger('<TRIGGER_NAME>',
  {
    to: {
      subscriberId: '<UNIQUE_IDENTIFIER>',
      email: '[email protected]',
      firstName: 'John',
      lastName: 'Doe',
    },
    payload: {
      name: "Hello World",
      organization: {
        logo: 'https://happycorp.com/logo.png',
      },
    },
  }
);

Embeddable notification center

Using the Novu API and admin panel you can easily add real-time notification center to your web-app without the hassle of building it yourself. You can use our React component or an iframe embed if you are not using React.

notification-center-912bb96e009fb3a69bafec23bcde00b0

Read more about how to add a notification center to your app with the Novu API here

Providers

Novu provides a single API to manage providers across multiple channels with a simple to use interface.

love_letter Email

telephone_receiver SMS

iphone Push (Coming Soon...)

  • Pushwoosh

point_down Direct (Coming Soon...)

  • Slack
  • MS Teams
  • Discord
  • Mattermost

iphone In-App

Other (Coming Soon...)

  • PagerDuty

computer Need Help?

We are more than happy to help you. If you are getting some errors or problems while working with the project, or want to discuss something related to the project.

Just Join Our Discord server and ask for help.

link Links


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK