sonos-web
This project is still in development, therefore the features may be buggy and / or limited
Description
sonos-web is a web interface for the Sonos Audio System, created with the goal of having a nice looking interface to manage the queue, add streaming services like Spotify (even for non-premium users!) and allow other developers to customized the UX as they want by making the project expandable through plugins.
Setup
First things first
To use sonos-web you need:
- Node.js (v6.x+)
- Git
- A Sonos Audio System
- An internet browser (Firefox is recommended)
- ffmpeg (in order to use the YouTube plugin)
Instructions
- Clone the repo
git clone https://github.com/denysvitali/sonos-web
- cd to the newly created folder (should be named
sonos-web
)
cd sonos-web/
- Install the dependencies
yarn install
- Compile the assets
npm run-script build
- Start the server
npm start
- See if it works, visit http://localhost:8888/ or visit http://your-server-ip:8888/ from another location
Note: It may be required to cd
into each plugins/ folder and do an npm install
to make sure everything works.
YouTube requires ffmpeg to be installed on your system.
Fedora / firewalld configuration
Allow upnp/ssdp:
firewall-cmd --set-default-zone=FedoraWorkstation
firewall-cmd --reload
Plugins
This is a list of planned plugins
Status:
- Spotify
β - Google Play Music
β - Plex
β - Soundcloud β
- YouTube
β
Party
Show your currently playing track with the "Party" plugin, already included in Sonos Web
TODO
- Complete the UI | Partially done
- Interact with Sonos system | Partially done
- Provide public methods for the plugins
- Write the plugins | Partially done
- Document everything