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成长。继续摇摆?