/novu

The open-source notification infrastructure for products. Add a notification center for your React, Vue and Angular apps ๐Ÿš€

Primary LanguageTypeScriptMIT LicenseMIT



Logo

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

โญ๏ธ Why Novu?

Building a notification system is complicated. At first, it seems like just sending an email, but in reality, it's just the beginning. Users today expect a multi-channel communication experience via email, SMS, push, chat, and other channels. An ever-growing list of providers is popping up daily, and notifications are spread around the code. Novu's goal is to simplify notifications and provide developers with the tools to create meaningful communication between the system and its users.

โœจ Features

  • ๐ŸŒˆ Single API for all messaging providers (Email, SMS, Push, Chat)
  • ๐Ÿ’… Easily manage notifications over multiple channels
  • ๐Ÿš€ Equipped with a CMS for advanced layouts and design management
  • ๐Ÿ›ก Built-in protection for missing variables (Coming Soon)
  • ๐Ÿ“ฆ Easy to set up and integrate
  • ๐Ÿ›ก Debug and analyze multi-channel messages in a single dashboard
  • ๐Ÿ“ฆ Embeddable notification center with real-time updates
  • ๐Ÿ‘จโ€๐Ÿ’ป Community driven

๐Ÿ“š Table Of Contents

๐Ÿ“‹ Read Our Code Of Conduct

Before you begin coding and collaborating, please read our Code of Conduct thoroughly to understand the standards (that you are required to adhere to) for community engagement. As part of our open-source community, we hold ourselves and other contributors to a high standard of communication. As a participant and contributor to this project, you are agreeing to abide by our Code of Conduct.

๐Ÿš€ 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: 'john1@doemail.com',
      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 a real-time notification center to your web app without 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.

๐Ÿ’Œ Email

๐Ÿ“ž SMS

๐Ÿ“ฑ Push

๐Ÿ‘‡ Chat

  • Slack
  • Discord
  • MS Teams
  • Mattermost

๐Ÿ“ฑ In-App

Other (Coming Soon...)

  • PagerDuty

๐Ÿ’ป Need Help?

We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our Discord server and ask for help. We are open to discussing anything related to the project.

๐Ÿ”— Links

๐Ÿ›ก๏ธ License

Novu is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ’ช Thanks To All Contributors

Thanks a lot for spending your time helping Novu grow. Keep rocking ๐Ÿฅ‚