Skip to content

HMIProject/helio-extension-template

Repository files navigation

HELIO Extension Template

This is the template repository for building HELIO extensions using the HELIO SDK. It provides a basic setup and includes all necessary tools for easy development. These include:

  • Rollup for building the extension,
  • Typescript for static typing,
  • ESLint for static analysis and issue reporting,
  • Prettier for automatic code formatting,
  • Vitest for automatic testing and
  • Storybook for UI documentation and development.

These tools are informed by our current preference and are included to make the process of building a HELIO extension as smooth as possible. However, none of them are required. Feel free to replace them with your own preferred options.

We have also pinned specific versions of Node.js and Yarn in the package.json file. This relies on the JavaScript Tool Manager Volta. Using these versions is also optional but can reduce unexpectedly inconsistent behavior across different machines.

Scripts

Building an Extension

yarn build

Run Tests

yarn test

Check for ESLint issues

yarn lint

Start Storybook

yarn storybook

About

Template for building extensions to the HELIO HMI system.

Topics

Resources

License

Stars

Watchers

Forks