novu

<div align="center"> <a href="https://novu.co?utm_source=github" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/2233092/213641039-220ac15f-f367-4d13-9eaf-56e79433b8c1.png"> <img alt="Novu标志" src="https://yellow-cdn.veclightyear.com/835a84d5/a9f48bea-0b9e-431d-a807-75f4a27dfb1f.png" width="280"/> </picture> </a> </div> <br/> <p align="center"> <a href="https://www.npmjs.com/package/@novu/node"> <img src="https://img.shields.io/npm/v/@novu/node" alt="NPM"> </a> <a href="https://www.npmjs.com/package/@novu/node"> <img src="https://img.shields.io/npm/dm/@novu/node" alt="npm下载量"> </a> <a href="https://github.com/novuhq/novu/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/novuhq/novu" alt="MIT"> </a> </p> <h1 align="center"> 为开发者打造的开源通知基础设施 </h1> <div align="center"> 通过单一API管理多渠道通知的终极服务。 </div> <p align="center"> <br /> <a href="https://docs.novu.co" rel="dofollow"><strong>浏览文档 »</strong></a> <br /> <br/> <a href="https://github.com/novuhq/novu/issues/new?assignees=&labels=type%3A+bug&template=bug_report.yml&title=%F0%9F%90%9B+Bug+Report%3A+">报告Bug</a> · <a href="https://github.com/novuhq/novu/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%F0%9F%9A%80+Feature%3A+">请求新功能</a> · <a href="https://discord.novu.co">加入我们的Discord</a> · <a href="https://roadmap.novu.co">路线图</a> · <a href="https://twitter.com/novuhq">X</a> · <a href="https://notifications.directory">通知目录</a> </p>

⭐️ 为什么选择Novu？

Novu提供了一个统一的API，使通过多个渠道发送通知变得简单，包括应用内、推送、电子邮件、短信和聊天。使用Novu，您可以创建自定义工作流程并为每个渠道定义条件，确保以最有效的方式传递您的通知。

✨ 特性

🌈 所有消息提供商（应用内、电子邮件、短信、推送、聊天）的单一API
💅 完全托管的GitOps流程，从您的CI部署
🔥 使用Zod或JSON Schema定义工作流程和步骤验证
💌 集成React Email/Maizzle/MJML
🚀 配备CMS用于高级布局和设计管理
🛡 在单一仪表板中调试和分析多渠道消息
📦 带有实时更新的可嵌入通知中心
👨‍💻 社区驱动

🚀 开始使用

要开始使用，请在终端中输入以下命令。

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('你好 {{subscriber.firstName}} - Acme评论'),
      openAiModel: z.enum(['gpt-3.5-turbo', 'gpt-4o']).default('gpt-4o'),
      aiPrompt: z.string().default('生成简洁的评论摘要'),
    })
  });
}, { payloadSchema: z.object({ name: z.string(), comment: z.string() }) });

await commentWorkflow.trigger({
  payload: { name: '约翰', comment: '你有空给我打个电话吗？' },
  to: 'jane@acme.com'
});

可嵌入的通知中心

使用Novu API和管理面板，您可以轻松地将实时通知中心添加到您的网络应用中，无需自己构建。您可以使用我们的React / Vue / Angular组件或iframe嵌入，以及Web组件。

阅读更多关于如何使用Novu API在您的应用中添加通知中心的信息这里

<p align="center"> <a href="https://docs.novu.co/sdks/react?utm_campaign=github-readme">React组件</a> · <a href="https://docs.novu.co/sdks/vue?utm_campaign=github-readme">Vue组件</a> · <a href="https://docs.novu.co/sdks/angular?utm_campaign=github-readme">Angular组件</a> </p> </div>