Giter VIP home page Giter VIP logo

roushanverma123 / novu Goto Github PK

View Code? Open in Web Editor NEW

This project forked from novuhq/novu

0.0 1.0 0.0 141.03 MB

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

Home Page: https://novu.co

License: MIT License

Shell 0.24% JavaScript 1.64% Python 3.18% TypeScript 92.92% CSS 0.03% HTML 0.97% Handlebars 0.27% Smarty 0.12% Vue 0.13% Dockerfile 0.24% EJS 0.10% MDX 0.17%

novu's Introduction

๐Ÿ‘จโ€๐Ÿ’ป We are hiring in Europe/UK/Israel! ๐Ÿ‘ฉโ€๐Ÿ’ป



NPM npm downloads MIT

The open-source notification infrastructure for developers

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


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

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, as well as a Web component.

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

โšก 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

novu's People

Contributors

scopsy avatar djabarovgeorge avatar davidsoderberg avatar ainouzgali avatar letitrock avatar biswaviraj avatar jainpawan21 avatar cliftonz avatar p-fernandez avatar renovate[bot] avatar abhilipsasahoo03 avatar michaldziuba03 avatar vannyle avatar peoray avatar sumitsaurabh927 avatar rifont avatar venarius avatar unicodeveloper avatar chavda-bhavik avatar raikasdev avatar parveshsaini avatar firassziedan avatar gitstart avatar aliaksandrryzhou avatar deepsource-autofix[bot] avatar tnajanssen avatar akshitagupta15june avatar combarnea avatar maximfedarau avatar alexvcs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.