You should have node (version 18+) installed as well as yarn installed. See yarnpkg.com for insall options.

You'll need to make sure that ableton-js is installed. You can find the installation steps here: leolabs/ableton-js.

yarn install

This project consists of a backend and frontend that you'll need to start independently. Both feature hot-reloading when files have changed, so you don't need to do anything special during development.

This package assumes that your lighting server is 127.0.0.1. If that's not the case, you'll want to change that in the .env file.

You can also change the port of the socket.io server via WS_SEVER_PORT and the exposed port of the osc server (for RFID events) via OSC_SERVER_PORT.

Once ableton-js is installed, run:

yarn start-backend

At which point you will have:

• an OSC server listening on port 9000, or whatever you've assigned to OSC_SERVER_PORT
• a Websocket server listening on port 3335, or whatever you've assigned to WS_SEVER_PORT
• a process listening to the socket exposed by ableton-js

To start the web ui run:

yarn dev

then navigate to http://localhost:5173 -- or whatever the console tells you.