open-index/open-npm huggingface dataset:
npm package: @ignite-signals/nuxt
Description: Ignite Signals Nuxt Module
Latest version: 1.0.80724

<div align="center">
  <a href="https://signals.ignite.systems">
    <img src="https://signals.ignite.systems/logo.png" alt="Ignite Signals Logo" height="80">
  </a>

<h3 align="center">Ignite Signals Nuxt Package</h3>

  <p align="center">
    Best-in-class telemetry collection for Brokers and Insurers
    <br />
    <a href="https://signals.ignite.systems"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://portal.signals.ignite.systems">Open Portal</a>
  </p>
</div>

<!-- GETTING STARTED -->
## Getting Started

**Not using Nuxt??** – head over to our [Vue package](https://www.npmjs.com/package/@ignite-signals/vue)

### Install package

1. Install
```bash
# 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`
```js
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
```vue
<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](https://signals.ignite.systems/packages/api/typescript) for more help