devanshukoli / novu-notification Goto Github PK

This project forked from novuhq/novu

The open-source notification infrastructure with fully functional embedded notification center

License: MIT License

Shell 0.28% JavaScript 1.55% Python 3.63% TypeScript 92.31% HTML 1.10% Handlebars 0.31% Vue 0.15% Dockerfile 0.23% EJS 0.11% MDX 0.19% Smarty 0.14%

novu-notification's Introduction

The open-source notification infrastructure for developers

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

🎉 We're participating in Hacktoberfest 2023! 🎉

Are you 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.

Our Hacktoberfest kickoff event is happening on October 2, 2023. 🚀
Check out our website for hacktoberfest instructions.
Join our Discord and engage with our community, get answers to your challenges, and stay updated on events, announcements, and prizes.

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 · X · 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
Embeddable notification center
Providers
- Email
- SMS
- Push
- Chat
- In-App
- Others
Need Help?
Links
License

🚀 Getting Started

We are excited to launch the complete Novu API and admin panel. Do you 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] (https://docs.novu.co/api-reference/events/trigger-event).

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: '[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 a real-time notification center to your web app without building it yourself. You can use our React / Vue / Angular components 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

Novu
MagicBell

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 agree 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 discussing anything related to the project.