Skip to content
forked from novuhq/novu

⭐ A fully functional real-time notification center for your web and react apps. The only open-source notifications infrastructure that manages multi-channel content, scheduled notifications, digest engine, user preferences, and delivers Email, SMS, Push and Chat notifications using a single API. ⚡

License

Notifications You must be signed in to change notification settings

ChuksJoshuaa/novu

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 Novu?

Building a notification system is hard, 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

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

👇 Chat

📱 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 with the project, then join our Discord server and ask for help. We are open to discuss anything related to the project.

📋 Read Our Code Of Conduct

Before moving on to coding and collaborating, please read our Code of Conduct throroughly to understand our standards (that you are required to adhere to) regarding how to engage in the community.

🔗 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 🥂

About

⭐ A fully functional real-time notification center for your web and react apps. The only open-source notifications infrastructure that manages multi-channel content, scheduled notifications, digest engine, user preferences, and delivers Email, SMS, Push and Chat notifications using a single API. ⚡

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.4%
  • JavaScript 3.5%
  • HTML 2.4%
  • Handlebars 0.8%
  • Dockerfile 0.4%
  • EJS 0.3%
  • Shell 0.2%