From dc7d0324fd3716b73fd5f59e1c4ae5dbfdc0a1e4 Mon Sep 17 00:00:00 2001 From: Guillermo Loaysa Date: Fri, 15 Mar 2024 21:54:28 +0100 Subject: [PATCH] feat: rename app to What's Playing --- .github/workflows/docker-publish.yml | 4 +-- README.md | 38 ++++++++++++++-------------- docker-compose.yml | 6 ++--- package-lock.json | 4 +-- package.json | 2 +- public/index.html | 2 +- public/manifest.json | 4 +-- src/views/Configuration.tsx | 2 +- 8 files changed, 31 insertions(+), 31 deletions(-) diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index dc4ae6f..9a55c5a 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -42,7 +42,7 @@ jobs: id: meta uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 with: - images: ghcr.io/gloaysa/plexart + images: ghcr.io/gloaysa/whatsplaying - name: Build and push Docker image uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 @@ -50,4 +50,4 @@ jobs: context: . push: true tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file + labels: ${{ steps.meta.outputs.labels }} diff --git a/README.md b/README.md index 771e778..93edd08 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,38 @@ -

PlexArt Display

+

What's Playing

-Welcome to PlexArt , a web application that brings your music to life. This project is all about showcasing your currently playing album art in a visually appealing way, turning your browser into a vibrant music hub. +Welcome to **What's Playing**, a web application that brings your music cover art from Plex to live. This project is all about showcasing your currently playing album art in a visually appealing way, turning your browser into a vibrant music hub. -PlexArt is more than just a pretty face. It offers basic music controls like play, pause, volume adjustment, and track navigation. But these controls are designed to be unobtrusive, appearing only when you need them, so the album art always takes center stage. +**What's Playing** is more than just a pretty face. It offers basic music controls like play, pause, volume adjustment, and track navigation. But these controls are designed to be unobtrusive, appearing only when you need them, so the album art always takes center stage. -One of the key features of PlexArt is the ability to browse through your Plex devices. Imagine a slide show where each slide is a different device, and you can flip through them with a simple swipe. +One of the key features of **What's Playing** is the ability to browse through your Plex devices. Imagine a slide show where each slide is a different device, and you can flip through them with a simple swipe. -But that's not all. PlexArt also has an 'Album Library' mode. Picture another slide show, this time with all the albums in your library. The slides change automatically, and the albums are chosen at random, so you never know what's coming next. It's like your own personal music lottery! +But that's not all. **What's Playing** also has an 'Album Library' mode. Picture another slide show, this time with all the albums in your library. The slides change automatically, and the albums are chosen at random, so you never know what's coming next. It's like your own personal music lottery! -The end goal of PlexArt is to be a dedicated music display in your living room or media room. It's a way to add a touch of style and interactivity to your music listening experience. +The end goal of **What's Playing** is to be a dedicated music display in your living room or media room. It's a way to add a touch of style and interactivity to your music listening experience. ## Features -PlexArt is packed with features designed to enhance your music listening experience: +**What's Playing** is packed with features designed to enhance your music listening experience: -- **Album Art Display**: The main feature of PlexArt is the ability to display the album art of the currently playing track. +- **Album Art Display**: The main feature of **What's Playing** is the ability to display the album art of the currently playing track. The album art takes up the entire screen, providing a visually appealing backdrop to your music. -- **Basic Music Controls**: PlexArt provides basic music controls including play, pause, volume adjustment, and track navigation. +- **Basic Music Controls**: **What's Playing** provides basic music controls including play, pause, volume adjustment, and track navigation. These controls are designed to be unobtrusive, appearing only when you interact with the screen. -- **Lyrics Display**: If available, PlexArt can show the lyrics of the currently playing song. +- **Lyrics Display**: If available, **What's Playing** can show the lyrics of the currently playing song. - **Device Carousel**: Browse through all your Plex devices with a simple swipe. Each device is displayed as a slide in a carousel, making it easy to switch between devices. - **Album Library Mode**: In Album Library mode, all the albums in your library are displayed in a carousel. The carousel auto-plays, changing slides every few seconds. The albums are chosen at random, providing a unique and engaging experience every time. -- **Works with your Sonos devices**: If you start a playlist or album on a Sonos device, PlexArt will automatically switch to that device and display the album art. +- **Works with your Sonos devices**: If you start a playlist or album on a Sonos device, **What's Playing** will automatically switch to that device and display the album art. ## Configurations -PlexArt can be customized to suit your needs by setting configurations. +**What's Playing** can be customized to suit your needs by setting configurations. The first time you run the application, you will be prompted to enter your Plex token and other configurations. - `PLEX_TOKEN`: MANDATORY. This is your Plex token. It's used to authenticate with your Plex server. @@ -51,16 +51,16 @@ Once you have set the configuration, if you ever want to change it again, naviga ## Screenshots Player: -![PlexArt](./example_player.png) +![What's Playing](./example_player.png) Album Library: -![PlexArt](./example_album.png) +![What's Playing](./example_album.png) Displaying lyrics: -![PlexArt](./example_lyrics.png) +![What's Playing](./example_lyrics.png) Displaying controls (mouse hovering over the album art or touching the screen): -![PlexArt](./example_controls.png) +![What's Playing](./example_controls.png) ## Running with Docker Compose @@ -72,10 +72,10 @@ First, you need to create a `docker-compose.yml` file in your project directory ```yaml version: '3.8' services: - plexart: - container_name: plexart + whatsplaying: + container_name: whatsplaying restart: unless-stopped - image: ghcr.io/gloaysa/plexart:main + image: ghcr.io/gloaysa/whatsplaying:main ports: - '5000:5000' ``` diff --git a/docker-compose.yml b/docker-compose.yml index 3d3d877..b24014a 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,8 +1,8 @@ version: '3.8' services: - plexart: - container_name: plexart + whatsplaying: + container_name: whatsplaying restart: unless-stopped build: . ports: - - '5000:5000' \ No newline at end of file + - '5000:5000' diff --git a/package-lock.json b/package-lock.json index 2f7200b..359bab9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "plexart", + "name": "whatsplaying", "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "plexart", + "name": "whatsplaying", "version": "0.1.0", "dependencies": { "@emotion/react": "^11.11.4", diff --git a/package.json b/package.json index 4a72954..d0bdefe 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "plexart", + "name": "whatsplaying", "version": "0.1.0", "private": true, "dependencies": { diff --git a/public/index.html b/public/index.html index 78a8e06..b33ecd8 100644 --- a/public/index.html +++ b/public/index.html @@ -24,7 +24,7 @@ work correctly both with client-side routing and a non-root public URL. Learn how to configure a non-root public URL by running `npm run build`. --> - Plexart + What's Playing diff --git a/public/manifest.json b/public/manifest.json index 3ed8ecc..6803391 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -1,6 +1,6 @@ { - "name": "Plexart", - "short_name": "Plexart", + "name": "What's Playing", + "short_name": "What's Playing", "theme_color": "#000000", "background_color": "#000000", "display": "fullscreen", diff --git a/src/views/Configuration.tsx b/src/views/Configuration.tsx index abffb2b..2bc50bb 100644 --- a/src/views/Configuration.tsx +++ b/src/views/Configuration.tsx @@ -78,7 +78,7 @@ export const Configuration: FunctionComponent = () => {
- PlexArt Display can be customized to suit your needs by setting + What's Playing can be customized to suit your needs by setting some configurations, like what Plex libraries you would like to hide from your Album showcase (you maybe have a library of type music for audiobooks or Christmas music to not have it merged with