Development

Prerequisites:

Follow these steps to install and run Freedeck’s bundled debug server on your operating system.

Clone Freedeck

git clone https://github.com/Freedeck/Freedeck.git

Install Dependencies

Navigate to the newly cloned Freedeck repository, then run

npm i

Run the Debug Server

It’s recommended at this point to split into two terminals: one for the Server, one for Companion.

To run the debug server, simply run the package script.

npm run debug-server

Run Companion

Don’t forget to run Companion. It’s recommended for this to be in a separate terminal.

npm run companion

Code formatting

Consider Prettier or Biome for code formatting.