Back to Novu

@novu/api Examples

libs/internal-sdk/examples/README.md

3.15.0536 B
Original Source

@novu/api Examples

This directory contains example scripts demonstrating how to use the @novu/api SDK.

Prerequisites

  • Node.js (v18 or higher)
  • npm

Setup

  1. Copy .env.template to .env:

    bash
    cp .env.template .env
    
  2. Edit .env and add your actual credentials

Running the Examples

To run an example file from the examples directory:

bash
npm run build && npx tsx example.ts

Creating new examples

Duplicate an existing example file, they won't be overwritten by the generation process.