README.md

RaveLights-UI

This is the interactive UI for RaveLights (https://github.com/danuo/ravelights).

Features

• Optimized for mobile devices.
• Written in Quasar/Vue3.js (Composition API).
• Global state management via Pinia Pinia.
• Uses REST Api from RaveLights.
• UI get's instantaneous updates through SSE (Server-sent events).

Installation for development

To use with RaveLights, the RaveLights-UI does not have to be installed manually. The most recent static built is already included in RaveLights. For development, RaveLights-UI can be run as follows:

Start the app in development mode (hot-code reloading, error reporting, etc.)

Install dependencies

npm i -g @quasar/cli
npm install

To run this ui in dev mode, run the following

quasar dev

Run RaveLights in no-ui mode:

python ./main.py --no-webui

Build the app for production

Manual building of this ui is not necessary. After pushing commits to master, the ui will be built by Github Actions. The updated ui built can then be included into ravelights via Github Submodules (see Readme of RaveLights, https://github.com/danuo/ravelights). To create a manual build anyway, run

quasar build