• Stars
    star
    32,304
  • Rank 488 (Top 0.01 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 2 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ”₯ The open-source notification infrastructure with fully functional embedded notification center πŸš€πŸš€πŸš€
πŸ‘¨β€πŸ’» 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)
  • πŸ’… Fully managed GitOps Flow, deployed from your CI
  • πŸ”₯ Define workflow and step validations with Zod or JSON Schema
  • πŸ’Œ React Email/Maizzle/MJML integrations
  • πŸš€ Equipped with a CMS for advanced layouts and design management
  • πŸ›‘ 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-labs@latest echo

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

client.workflow('comment-on-post', async ({step, subscriber}) => {
  const inAppResponse = await step.inApp('in-app-step', async (inputs) => {
    return {
      body: renderReactComponent(inputs)
    };
  }, {
    inputSchema: {
      // ...JSON Schema or ZOD/Ajv/Class Validators definition
    }
  });

  // Novu Worker Engine will manage the state and durability of each step in isolation
  const { events } = await step.digest('1 day');

  await step.email('email-step', async () => {
    return {
      subject: 'E-mail Subject',
      body: renderReactEmail(<ReactEmailComponent events={digestedEvents} />);
    }
  }, {
    // Step-level inputs defined in code and controlled in the novu Cloud UI by a Non-Technical Team member
    inputSchema: {
      // ...JSON Schema
    },
    providers: {
      sendgrid: async (inputs) => {
        // Echo runs as part of your application, so you have access to your database or resources

        return {
          to: email,
          ipPoolName: 'custom-pool'
        };
      }
    },
    skip: () => {
      // Write custom skip logic
      return inAppResponse.seen || subscriber.isOnline;
    }
  });
// Define your workflow trigger payload using json schema and custom validation;
}, {
  payloadSchema: {
    // ...JSON Schema
  }
});

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

More Repositories

1

blog

JavaScript
605
star
2

hacksquad-website

Contribute code, meet community members, participate in workshops, and win more SWAG πŸš€
JavaScript
253
star
3

novu-php

PHP SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
PHP
83
star
4

json-to-typescript-chatgpt

JavaScript
75
star
5

novu-python

Python SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
Python
69
star
6

go-novu

GO SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
Go
52
star
7

website

JavaScript
29
star
8

notification-directory-react

JavaScript
26
star
9

novu-elixir

Elixir SDK for Novu
Elixir
26
star
10

novu-dotnet

.NET SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
C#
24
star
11

novu-ruby

Ruby SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
Ruby
22
star
12

novu-java

Java SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
Java
21
star
13

novu-kotlin

Kotlin SDK for Novu - The open-source notification infrastructure for engineers. πŸš€
Kotlin
19
star
14

novu-rust

Rust
15
star
15

connect-readme

Join ConnectNovu Hackathon, showcase your skills, push the boundaries of innovation, and meet like-minded community members.
13
star
16

hacksquad-background

Hacksquad Background Processes
TypeScript
11
star
17

notification-center-demo

JavaScript
10
star
18

mongo-to-D2

JavaScript
10
star
19

api-docs

JavaScript
10
star
20

hacksquad

πŸš€ Join Hacktoberfest 2021 with your squad
Less
9
star
21

docs

The new novu documentation on steroids!
MDX
8
star
22

vanillajs-quickstart

JavaScript
8
star
23

connect

JavaScript
8
star
24

nordle

Easy to use Wordle built in Next.js
TypeScript
8
star
25

novu-python-legacy

A python wrapper for the Notifire API
7
star
26

examples

CSS
7
star
27

contributors

TypeScript
6
star
28

badges

TypeScript
6
star
29

nextjs-quickstart

JavaScript
6
star
30

notion-to-github-sync-action

A GitHub action to sync notion pages to markdown files on GitHub
JavaScript
4
star
31

notification-generator-frontend

JavaScript
2
star
32

saascomponents-io

The SaaS Components Map
JavaScript
2
star
33

novu-laravel

Laravel SDK for Novu
PHP
2
star
34

novu-headless-demo-app

JavaScript
2
star
35

vue-quickstart

Getting Started Guide to integrate Novu Notification Center in Vue apps
Vue
2
star
36

node

A nodejs package for interacting with the notifire api
TypeScript
2
star
37

novu-php-quickstart

Quickstart sample app that shows how to trigger notifications from a PHP app using Novu.
PHP
2
star
38

digest-email-app

JavaScript
2
star
39

novu-ruby-quickstart

This sample demonstrates how to trigger notifications from a ruby app
Ruby
2
star
40

nestjs-quickstart

Quickstart sample app that shows how to trigger notifications from a NestJS app using Novu.
TypeScript
2
star
41

nodejs-sdk-quickstart

Quickstart sample app that shows how to trigger notifications from a Node.js app using Novu.
JavaScript
2
star
42

react-quickstart

JavaScript
2
star
43

kotlin

1
star
44

novu-dotnet-legacy

1
star
45

cms

JavaScript
1
star
46

the-office

JavaScript
1
star
47

nodejs-cli-app

JavaScript
1
star
48

angular-quickstart

HTML
1
star
49

nogi

A Notion to Docasaurus on GitHub sync
TypeScript
1
star
50

digest-learning-app

JavaScript
1
star
51

simple-notifications

HTML
1
star
52

provider-template

A template provider for notifire
TypeScript
1
star
53

fcm-react-native-android

JavaScript
1
star
54

novu-kotlin-quickstart

Kotlin
1
star
55

novu-dotnet-quickstart

C#
1
star
56

novu-java-quickstart

Java
1
star