Contributor Setup

This page is for contributors, developers, and advanced testers working from the repository.

If you are trying to use PELS in your home after installing it on Homey Pro, go to Getting Started instead.

What this page is for

Use this page when you need to:

• clone the repository
• run the docs site locally
• validate the Homey app bundle
• install a development build on Homey Pro

What you need

• Node.js 22.x — the major Homey Pro runs, so the app is built and type-checked against it. Newer majors are not supported here.
• npm 12.x
• Homey CLI installed globally:

npm install -g homey

• A Homey Pro if you want to install and test the app itself

Clone and install dependencies

git clone https://github.com/olemarkus/com.barelysufficient.pels.git
cd com.barelysufficient.pels
npm install

npm 12 blocks dependency install scripts unless they are allow-listed, so the install ends with a warning that esbuild and unrs-resolver had their postinstall blocked. That is expected — both ship their platform binaries as optional dependencies, so the build and the linter work without those scripts.

Run the docs site locally

npm run docs:dev

This starts the docs site locally so you can review content and styling changes while editing the docs.

Validate the app bundle

npm run validate

This runs Homey validation and the packaging check.

Install a development build on Homey

homey login
npm run install-app

Only use this path when you are intentionally testing from source.

Other useful commands

npm run docs:build
npm run lint
npm run ci:checks

Audience split

• Getting Started is for end users working with an already installed app.
• This page is for people working with the repository and development workflows.