Git Product home page Git Product logo

paulfasola / novu Goto Github PK

View Code? Open in Web Editor NEW

This project forked from novuhq/novu

0.0 1.0 0.0 124.18 MB

🚀 The open-source notifications infrastructure. A fully-featured microservice to send SMS, E-mail, Slack and Push notifications. Embeddable notification center for React with real-time updates, content management, and much more...

Home Page: https://novu.co

License: MIT License

Shell 0.17% JavaScript 3.90% TypeScript 91.49% HTML 2.78% Handlebars 0.93% Dockerfile 0.36% EJS 0.37%

novu's Introduction

Logo Dark

Logo Light

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 🥂

novu's People

Contributors

scopsy avatar djabarovgeorge avatar ainouzgali avatar davidsoderberg avatar vannyle avatar venarius avatar jainpawan21 avatar combarnea avatar raikasdev avatar alexvcs avatar galezra avatar renovate-bot avatar devblin avatar samsoft00 avatar biswaviraj avatar andrewgolovanov avatar prodoomman avatar wintercore avatar bigpreshy avatar wpoynter avatar fidalmathew avatar charliebrowncharacter avatar rutam21 avatar lian1230 avatar maurerkrisztian avatar rockingrohit9639 avatar diganta413 avatar oba2311 avatar nishit-g avatar kymppi avatar

Watchers

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