novu
v2.0.1
Explorez les documents »
ou
créer un compte gratuit »
Signaler un bug · Demandez une fonctionnalité · Rejoignez notre discorde · Fonde de route · X · Contactez-nous
Novu fournit une API unifiée qui facilite l'envoi de notifications via plusieurs canaux, notamment Inbox / In-App, Push, Email, SMS et CHAT. Avec Novu, vous pouvez créer des workflows personnalisés et définir des conditions pour chaque canal, en vous garantissant que vos notifications sont livrées de la manière la plus efficace possible.
Il y a deux façons de commencer:
npx novu@latest devPour la documentation et la référence de l'API, veuillez visiter notre référence 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]'
} ) ; À l'aide de l'API NOVU et du panneau d'administration, vous pouvez facilement ajouter un centre de notification en temps réel à votre application Web sans la construire vous-même. Vous pouvez utiliser notre réact ou construire le vôtre via notre API et notre SDK. React Native, Vue et Angular arrivent bientôt.
En savoir plus sur la façon d'ajouter une boîte de réception du centre de notification à votre application.
Novu fournit une seule API pour gérer les fournisseurs sur plusieurs canaux avec une interface API et UI simple à utiliser.
Avant de commencer à coder et à collaborer, veuillez lire notre code de conduite à fond pour comprendre les normes (auxquelles vous devez adhérer) pour l'engagement communautaire. Dans le cadre de notre communauté open source, nous nous tenons et d'autres contributeurs à un niveau de communication élevé. En tant que participant et contributeur à ce projet, vous acceptez de respecter notre code de conduite.
Nous sommes plus qu'heureux de vous aider. Si vous obtenez des erreurs ou faites face à des problèmes pendant que vous travaillez sur ce projet, rejoignez notre serveur Discord et demandez de l'aide. Nous sommes ouverts à discuter de tout ce qui concerne le projet.
Novu est une société open source commerciale, ce qui signifie que certaines parties de ce référentiel open source nécessitent une licence commerciale. Le concept est appelé «Open Core», où la technologie de base est entièrement open source, sous licence MIT, et le code d'entreprise est couvert par une licence commerciale (Edition Enterprise Edition). Les fonctionnalités d'entreprise sont construites par l'équipe d'ingénierie de base de Novu qui est embauchée à temps plein.
Les modules et dossiers suivants sont autorisés sous la licence d'entreprise:
enterprise à la racine du projet et tous leurs sous-dossiers et modulesapps/web/src/ee et tous leurs sous-dossiers et modulesapps/dashboard/src/ee et tous leurs sous-dossiers et modules Merci beaucoup d'avoir passé votre temps à aider Novu à grandir. Continuez à basculer?
