snapcast-ui

Snapcast UI

Snapcast UI is a static user interface built on Snapcast to control multi-room audio playback.

A static UI built on Snapcast.

Overview

Tools

• ReactJS
• Component Library MatUI
• Loading Animations cssloaders
• Icons

Backend

It uses WebSockets to interact with the Snapcast JSON RPC API for server communication.

Local Testing

You can develop Snapcast UI locally using Docker Compose with mock Snapcast client and server services. Here are the steps:

1. Install docker and docker compose.
2. Copy .env.example to .env
3. Run docker compose up
4. Open http://localhost:3000/ in your web browser.

Customization

Themes: default, roses, tropic, 80s

Build and Install

There are two ways to host the static site: using Docker with the prebuilt nginx configuration or building the static files locally and serving them with a tool like npm serve.

Build Args

REACT_APP_HOME_TITLE="Home Audio"
REACT_APP_SNAPCAST_HOST="ws://localhost:1780"
REACT_APP_THEME="default"

Using Docker

To use Docker, check out the build-example.sh file and modify the build args accordingly. Here is an example docker-compose.yaml:

version: '3'
services:
    frontend:
        image: "my-registry:latest"
        ports:
            - "3000:3000"

Using npm serve

To build and serve the static files locally, follow these steps:

1. Install NodeJS.
2. npm install --global serve
3. npm install
4. Copy .env.example to .env changing as needed.
5. npm build
6. serve build/

The environment variables are read from the .env file when running npm build.

This site is open source. Improve this page.