generator-signalk-plugin

Generates a plugin for the SignalK Node server

Usage no npm install needed!

<script type="module">
  import generatorSignalkPlugin from 'https://cdn.skypack.dev/generator-signalk-plugin';
</script>

README

generator-signalk-plugin

A Yoeman generator for initializing a SignalK Node Server Plugin development project.

Features

  • Jumpstarts plugin development by generating complete project using SignalKPlugin class
  • Initial scaffolding writes code to subscribe to the most common SignalK data streams
  • Generates plugin configuration options to allow end user to change SignalK paths and/or limit data to a specific data source
  • Supports optional front end UI Webapp development using React
  • Supports optional RESTful API calls to your plugin to retrieve data

Usage

Installing Yoeman and this generator:

npm install -g yo
npm install -g generator-signalk-plugin

Once you have done that, create a new directory to hold your project, make that directory your current working directory, then run the generator using:

yo signalk-plugin

Answer the questions, and voila!