Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peguerosdc/subplayer
A music player frontend compatible with Subsonic backends
https://github.com/peguerosdc/subplayer
airsonic audio audio-streaming home-media music music-player music-streaming react rsuite self-hosted subsonic subsonic-client
Last synced: 3 months ago
JSON representation
A music player frontend compatible with Subsonic backends
- Host: GitHub
- URL: https://github.com/peguerosdc/subplayer
- Owner: peguerosdc
- License: gpl-3.0
- Created: 2019-07-18T18:42:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-18T07:26:43.000Z (almost 4 years ago)
- Last Synced: 2024-06-21T12:25:44.541Z (5 months ago)
- Topics: airsonic, audio, audio-streaming, home-media, music, music-player, music-streaming, react, rsuite, self-hosted, subsonic, subsonic-client
- Language: JavaScript
- Homepage: https://subplayer.netlify.app/
- Size: 5.12 MB
- Stars: 85
- Watchers: 7
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - peguerosdc/subplayer - A music player frontend compatible with Subsonic backends (self-hosted)
README
# Subplayer
[](https://codecov.io/gh/peguerosdc/subplayer)
[](https://travis-ci.com/peguerosdc/subplayer)
This is a frontend application designed to be a simple, functional and nice looking web player to be used with a Subsonic backend (tested with [spl0k/supysonic](https://github.com/spl0k/supysonic) and [deluan/navidrome](https://github.com/deluan/navidrome)).
Live Demo: [Subplayer at Netlify](https://subplayer.netlify.app/)
## Features
- Play and seek audio
- View/create/edit playlists
- Add/remove songs from Starred
- Search artists/albums/songs
- Browse your music by Artist, Albums and Genres (only compatible with v1.13.0)
- Star/unstar albums
- Scrobble
- Add/Remove from queue
- Theming
### Building custom themes
By default, the only themes available are Blue, Orange, Green and Grey (all in light and dark mode). If you want to create your custom themes, you can edit `/themes.config.js` with your own object to change how Rsuite will look like. Each theme must be named starting with either "light" or "dark" to let the compiler know which settings to load.
To see the list of variables that you can define for customization, visit [RSuite's documentation](https://rsuitejs.com/en/guide/themes/).
**NOTE:** the tool that Rsuite provides to create custom themes is not designed to work with `create-react-app` (which is how this project was built), so the implementation here is considered a hack and, as a result, it has (as far as I found) two downsides:
1) you can't create a lot of themes as the compiler will run out of memory (that's why I only defined 4 colours by default) and
2) on the first run, you will see a blank page. After reloading, the application will work as expected.
## Installation
### Running the source code
Clone the repository and run from the root folder:
```
$ yarn install
$ yarn start
```
### Docker installation
To build the image yourself:
```
$ docker build . -t peguerosdc/subplayer
```
Or using the experimental `buildx` to build (and push) for multiple platforms:
```
$ docker buildx build --platform linux/arm64,linux/amd64 --push -t peguerosdc/subplayer .
```
To run the image:
```
$ docker run --name mysubplayer \
-p 8000:80 \
--restart unless-stopped \
-d peguerosdc/subplayer
```
To stop:
```
$ docker stop mysubplayer
```
## TODO
- Implement CI to push Docker image automatically when merged to `master`
- There are some `TODO`s in the unit tests, but most features are tested.
- `feature`: Rearrange items in queue. I tried this with the current rsuite's Table but didn't like the final implementation. I am thinking in (someday) writing a new `` from scratch to add all the features I want.
- Re-work `MusicPlayer`.
- How to test components with hooks without 1) using `mount` and 2) re-doing all the unit tests with React Testing Library?
## Contributions
Any TODO item, any bug you find and want to fix, any architecture/performance/Docker improvements, any new feature you think would be cool to have is welcome :) Just keep in mind that this project is meant to be a lightweight application.
**NOTE**: if you want to add new features, please implement at least the basic unit tests you can think of. Pull-requests will not be merged without testing.
## Acknowledgements
- Favicon made by Freepik from www.flaticon.com
- Using [rsuite/rsuite](https://github.com/rsuite/rsuite) UI components.
## License
Licensed under the [GNU General Public License v3.0](https://github.com/peguerosdc/rsuite-sonicplayer/blob/master/LICENSE).