novu
v2.0.1
Explore os documentos »
ou
Crie uma conta gratuita »
Relate um bug · Solicite um recurso · Junte -se à nossa discórdia · Roteiro · x · Entre em contato conosco
A Novu fornece uma API unificada que simplifica o envio de notificações por meio de vários canais, incluindo caixa de entrada/aplicativo, push, email, SMS e bate-papo. Com o NOVU, você pode criar fluxos de trabalho personalizados e definir condições para cada canal, garantindo que suas notificações sejam entregues da maneira mais eficaz possível.
Existem duas maneiras de começar:
npx novu@latest devPara documentação e referência da API, visite nossa referência da 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]'
} ) ; Usando a API Novu e o painel de administração, você pode adicionar facilmente um centro de notificação em tempo real ao seu aplicativo da Web sem construí-lo. Você pode usar o nosso React ou construir o seu próprio através da nossa API e SDK. Reacta nativa, vue e angular estão chegando em breve.
Leia mais sobre como adicionar uma caixa de entrada do centro de notificação ao seu aplicativo.
A NOVU fornece uma única API para gerenciar provedores em vários canais com uma interface API e interface da interface do usuário simples.
Antes de começar a codificar e colaborar, leia minuciosamente nosso código de conduta para entender os padrões (para os quais você deve aderir) para o envolvimento da comunidade. Como parte de nossa comunidade de código aberto, mantemos a nós mesmos e outros colaboradores de um alto padrão de comunicação. Como participante e colaborador deste projeto, você concorda em cumprir nosso código de conduta.
Estamos mais do que felizes em ajudá -lo. Se você estiver recebendo erros ou enfrentando problemas enquanto trabalha neste projeto, junte -se ao nosso servidor Discord e peça ajuda. Estamos abertos a discutir qualquer coisa relacionada ao projeto.
A Novu é uma empresa comercial de código aberto, o que significa que algumas partes deste repositório de código aberto exigem uma licença comercial. O conceito é chamado "Open Core", onde a tecnologia principal é totalmente de código aberto, licenciado sob licença do MIT, e o código corporativo é coberto por uma licença comercial ("/Enterprise" Enterprise Edition). Os recursos corporativos são construídos pela equipe de engenharia principal da NOVU, contratada em tempo integral.
Os seguintes módulos e pastas são licenciados sob a licença corporativa:
enterprise na raiz do projeto e em todas as suas subpastas e módulosapps/web/src/ee Pasta e todas as suas subpastas e módulosapps/dashboard/src/ee e todas as suas subpastas e módulos Muito obrigado por gastar seu tempo ajudando a Novu a crescer. Continuar balançando?
