An alternative, open-source stream deck made for any touchscreen device.
This readme contains developer documentation, for user documentation and guides visit https://touchdeck.app/documentation.
Install all dependencies:
npm i --prefix agent
npm i --prefix model
npm i --prefix web
Start the agent:
npm start --prefix agent
Start the web interface:
npm start --prefix web
View the deck at: http://localhost:3000
Any changes made to the code will automatically cause the apps to reload. All modules have a format
script to format (and optionally lint) the code. For example, to format the agent:
npm run format --prefix agent
The module contains the agent code, which runs on the host pc.
The agent can be configured through environment variables.
Variable | Default | Description |
---|---|---|
LOG_LEVEL |
INFO |
The log level (DEBUG , INFO , WARN , ERROR or OFF ). |
CONFIG_DIR |
~/.touchdeck |
The directory to store configuration files in. This directory contains a config.json file containing the full agent configuration. |
WS_PROXY_SERVER |
wss://wsproxy.touchdeck.app |
The websocket proxy server to connect to. |
This module contains shared models, used by both the agent and web module.
This module contains the web code, which is deployed on https://deck.touchdeck.app.