novu
v2.0.1
Explore los documentos »
o
crear una cuenta gratuita »
Informe un error · solicitar una función · Únase a nuestra discordia · Hoja de ruta · x · Contáctenos
Novu proporciona una API unificada que facilita el envío de notificaciones a través de múltiples canales, incluidas la bandeja de entrada/aplicación, push, correo electrónico, SMS y chat. Con Novu, puede crear flujos de trabajo personalizados y definir condiciones para cada canal, asegurando que sus notificaciones se entreguen de la manera más efectiva posible.
Hay dos formas de comenzar:
npx novu@latest devPara la documentación y la referencia de la API, visite nuestra referencia de 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 la API y el panel de administración de Novu, puede agregar fácilmente un centro de notificación en tiempo real a su aplicación web sin construirlo usted mismo. Puede usar nuestro React o construir el suyo a través de nuestra API y SDK. React Native, Vue y Angular llegarán pronto.
Lea más sobre cómo agregar una bandeja de entrada central de notificación a su aplicación.
Novu proporciona una única API para administrar proveedores en múltiples canales con una interfaz API y UI simple de usar.
Antes de comenzar a codificar y colaborar, lea nuestro código de conducta a fondo para comprender los estándares (a los que debe cumplir) para la participación de la comunidad. Como parte de nuestra comunidad de código abierto, nos mantenemos a nosotros mismos y a otros contribuyentes a un alto nivel de comunicación. Como participante y contribuyente a este proyecto, usted acepta cumplir con nuestro Código de Conducta.
Estamos más que felices de ayudarlo. Si recibe algún error o se enfrenta a problemas mientras trabaja en este proyecto, únase a nuestro servidor de Discord y solicite ayuda. Estamos abiertos a discutir cualquier cosa relacionada con el proyecto.
Novu es una empresa comercial de código abierto, lo que significa que algunas partes de este repositorio de código abierto requieren una licencia comercial. El concepto se llama "Núcleo abierto", donde la tecnología central es de código abierto, licenciada bajo la licencia MIT, y el código empresarial está cubierto por una licencia comercial ("/Enterprise" Enterprise Edition). Las características empresariales están construidas por el equipo central de ingeniería de Novu, que se contrata a tiempo completo.
Los siguientes módulos y carpetas tienen licencia bajo la licencia empresarial:
enterprise en la raíz del proyecto y todas sus subcarpetas y módulosapps/web/src/ee y todas sus subcarpetas y módulosapps/dashboard/src/ee y todas sus subcarpetas y módulos Muchas gracias por pasar su tiempo ayudando a Novu a crecer. ¿Sigue balanceándose?
