/novu

๐Ÿ”ฅ The open-source notification infrastructure with fully functional embedded notification center ๐Ÿš€๐Ÿš€๐Ÿš€

Primary LanguageTypeScriptMIT LicenseMIT

![Novu Logo]

The open-source notification infrastructure for developers

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

๐ŸŽ‰ Novu is live on Product Hunt! ๐ŸŽ‰

We are on Product Hunt and would appreciate any help you can give us ๐Ÿฉท
BONUS: watch our video, answer the riddle, and win awesome swag!



๐ŸŽ‰ We're participating in Hacktoberfest 2023! ๐ŸŽ‰

Interested in participating in Hacktoberfest? We extend a warm invitation! You also get the opportunity to win some swag ๐Ÿ˜

โญ๏ธ If you're new to Hacktoberfest, you can learn more and register to participate here. Registration is from September 26th - October 31st.

In addition to this repository, here are the other Novu repositories you can contribute to for Hacktoberfest:

Your contribution, no matter its size, holds immense value. We eagerly await to see the impact you'll make in our community! ๐Ÿš€


Explore the docs ยป

Report Bug ยท Request Feature ยท Join Our Discord ยท Roadmap ยท Twitter ยท Notifications Directory

Available in: Node.js ยท PHP ยท Go ยท Ruby ยท Kotlin ยท Elixir ยท Rust ยท Python ยท Java

โญ๏ธ Why Novu?

Novu provides a unified API that makes it simple to send notifications through multiple channels, including In-App, Push, Email, SMS, and Chat. With Novu, you can create custom workflows and define conditions for each channel, ensuring that your notifications are delivered in the most effective way possible.

โœจ Features

  • ๐ŸŒˆ Single API for all messaging providers (In-App, 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.

For API documentation and reference, please visit Novu API Reference.

To get started with the Node.js package, you can install it using npm:

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 / Vue / Angular component or an iframe embed.

notification-center-912bb96e009fb3a69bafec23bcde00b0

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

React Component ยท Vue Component ยท Angular Component

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

๐Ÿ“‹ 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.

๐Ÿ’ป 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 discuss anything related to the project.

โšก Immediate working space with Gitpod

Open in Gitpod

๐Ÿ”— 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 ๐Ÿฅ‚

Contributors