Getting Started

Ignite Signals has three core components which your service will integrate with:

• Ignite Signals API – You will use this service to perform actions such as check compatibility and read collected data.
• Ignite Signals Components – Our component library allows your team to simply onboard customer devices into Ignite Signals. We provide first-class support for Vue, Nuxt and Web-Components.
• Ignite Signals Portal – You can manage your Ignite Signals account, view connected devices and diagnose issues on your portal.

Install Packages

1. Install Ignite Signals API to your server side project:

Typescript/Javascript

pnpm i --save @ignite-signals/api

yarn add --save @ignite-signals/api

npm i --save @ignite-signals/api

Other

If your server side project does not use Typescript or Javascript we also have OpenAPI documentation for all our HTTP API endpoints here.

2. Install the Ignite Signals components library:

Vue

pnpm i --save @ignite-signals/vue

yarn add --save @ignite-signals/vue

npm i --save @ignite-signals/vue

Nuxt

pnpm i --save @ignite-signals/nuxt

yarn add --save @ignite-signals/nuxt

npm i --save @ignite-signals/nuxt

Other Web Framework

If you are Web Frameworks other than Vue such as React or Angular (or no web framework at all!) we provide Web Components for your project.

Package Install

pnpm i --save @ignite-signals/web-components

yarn add --save @ignite-signals/web-components

npm i --save @ignite-signals/web-components

HTML Import

<script src="https://unpkg.com/@ignite-signals/web-components@1.0.0/ignite-signals-web-components.js" crossorigin></script>