Skip to content

nhedger/nuxt-inngest

Repository files navigation

Nuxt Inngest

npm version npm downloads License Nuxt

Inngest integration for Nuxt.

Quick Setup

  1. Add nuxt-inngest dependency to your project
# Using npm
npm install --save-dev nuxt-inngest

# Using pnpm
pnpm add -D nuxt-inngest

# Using yarn
yarn add --dev nuxt-inngest

# Using bun
bun add --D nuxt-inngest
  1. Add nuxt-inngest to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    'nuxt-inngest'
  ]
})

Add the following configuration to your .env file replacing the value in < > with your Inngest API key.

NUXT_INNGEST_EVENT_KEY="<your_inngest_event_key>"

That's it! You can now use Nuxt inngest in your Nuxt app ✨

Development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run checks
pnpm run check

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release