Skip to content

Latest commit

 

History

History
181 lines (130 loc) · 6.15 KB

README.md

File metadata and controls

181 lines (130 loc) · 6.15 KB

hacktoberfest-readme-dark

hacktoberfest-readme-light



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

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, chat 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.

✨ Features

  • 🌈 Single API for all messaging providers (Email, SMS, Push, Chat)
  • 💅 Easily manage notification 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

🚀 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.

💌 Email

📞 SMS

📱 Push

  • FCM
  • Pushwoosh
  • SNS

👇 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 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.

🔗 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. Thanks a lot! Keep rocking 🥂