Getting Started

Not using Nuxt?? – head over to our Vue package

Install package

1. Install

# Using pnpm
pnpm add -D @ignite-signals/nuxt

# Using yarn
yarn add --dev @ignite-signals/nuxt

# Using npm
npm install --save-dev @ignite-signals/nuxt

2. Add @ignite-signals/nuxt to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    '@ignite-signals/nuxt'
  ]
})

3. Start using Ignite Signals components in your project! For example here we using the SignalsOnboarding component to get a device registered with Ignite Signals

<SignalsOnboarding
  organisation-name="SkyNet"
  organisation-logo-url="https://sky.net/logo.png"
  workflow-token="your_workflow_token"
  @complete="onOnboardingComplete"
  @error="onOnboardingError"
/>

4. Refer to the documentation for more help