novu
v2.0.1
探索文檔»
或者
創建一個免費帳戶»
報告一個錯誤·請求功能·加入我們的不和諧·路線圖·x·與我們聯繫
Novu提供了一個統一的API,可以簡單地通過多個渠道發送通知,包括收件箱/應用程序,推送,電子郵件,SMS和聊天。使用Novu,您可以創建自定義工作流並為每個頻道定義條件,以確保您的通知以最有效的方式傳遞。
有兩種開始方法:
npx novu@latest dev
有關API文檔和參考,請訪問我們的API參考。
import { workflow , CronExpression } from '@novu/framework' ;
import { z } from 'zod' ;
import { render } from '@react-email/render' ;
const commentWorkflow = workflow ( 'comment-workflow' , async ( event ) => {
const digest = await event . step . digest ( 'digest-comments' , ( controls ) => ( {
cron : controls . schedule
} ) , { controlSchema : z . object ( { schedule : z . nativeEnum ( CronExpression ) } ) } ) ;
await event . step . email ( 'digest-email' , async ( controls ) => ( {
subject : controls . subject ,
body : render ( < WeeklyDigestEmail { ... controls } events = { digest . events } / > )
} ) , {
skip : ( ) => ! digest . events . length ,
controlSchema : z . object ( {
subject : z . string ( ) . default ( 'Hi {{subscriber.firstName}} - Acme Comments' ) ,
openAiModel : z . enum ( [ 'gpt-3.5-turbo' , 'gpt-4o' ] ) . default ( 'gpt-4o' ) ,
aiPrompt : z . string ( ) . default ( 'Produce a concise comment digest' ) ,
} )
} ) ;
} , { payloadSchema : z . object ( { name : z . string ( ) , comment : z . string ( ) } ) } ) ;
await commentWorkflow . trigger ( {
payload : { name : 'John' , comment : 'Are you free to give me a call?' } ,
to : '[email protected]'
} ) ;
使用NOVU API和Admin面板,您可以在不自行構建的情況下輕鬆地為Web應用程序添加一個實時通知中心。您可以使用我們的React,也可以通過我們的API和SDK構建自己的React。反應本地,VUE和Angular即將到來。
閱讀有關如何在應用程序中添加通知中心收件箱的更多信息。
NOVU提供了一個單個API,可以通過易於使用的API和UI接口管理多個渠道的提供商。
在開始編碼和協作之前,請徹底閱讀我們的行為準則,以了解社區參與的標準(您必須遵守的標準)。作為我們開源社區的一部分,我們將自己和其他貢獻者保持在高水平的溝通中。作為該項目的參與者和貢獻者,您同意遵守我們的行為準則。
我們很樂意為您提供幫助。如果您在研究此項目時遇到任何錯誤或面臨問題,請加入我們的Discord服務器並尋求幫助。我們願意討論與該項目有關的任何內容。
Novu是一家商業開源公司,這意味著該開源存儲庫的某些部分需要商業許可。該概念稱為“開放核心”,其中核心技術是完全開源的,在MIT許可下獲得許可,並且企業代碼按商業許可(“/企業”企業版)涵蓋。企業功能由Novu的核心工程團隊構建,該團隊被全職僱用。
以下模塊和文件夾已根據企業許可證獲得許可:
enterprise
文件夾apps/web/src/ee
文件夾及其所有子文件夾和模塊apps/dashboard/src/ee
文件夾及其所有子文件夾和模塊非常感謝您花時間幫助Novu成長。繼續搖擺?