From 20f4ef7bb322f3003e865dd4f9caf2820dab8e45 Mon Sep 17 00:00:00 2001 From: Ipmake Date: Sat, 4 Jan 2025 03:56:56 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c25cce2..1ce16bb 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ Fixing Plex's old and simple UI. ## Description -PerPlexed is a complete redesign of Plex's UI using the plex media server's API. It comes with its own web server. As the keen eye may notice, the UI is heavily inspired by Netflix's UI. It is currently only developed for desktops and laptops. It is not optimized for mobile or TV use. +PerPlexed is a complete redesign of Plex's UI using the Plex media server's API. It comes with its own web server. As the keen eye may notice, the UI is heavily inspired by Netflix's UI. It is currently only developed for desktops and laptops. It is not optimized for mobile or TV use. PerPlexed currently supports Movie and TV Show libraries. You can also play media via the interface. -It is currently not possible to edit media metadata or switch between different Plex servers. The "+" and Star buttons on the info pages for shows and movies are placeholders are currently not functional. +It is currently not possible to edit media metadata or switch between different Plex servers. The "+" and Star buttons on the info pages for shows and movies are placeholders and are currently not functional. Mind that this project is still in development and may be unstable. @@ -34,13 +34,18 @@ docker run --name perplexed -p 3000:3000 -e PLEX_SERVER=http://your-plex-server: | DISABLE_TLS_VERIFY | true/false | No | Disable TLS verification on https plex servers | ## Contributing -Pull requests are welcome for any feature or bug fix. For major changes, please open an issue first to discuss what you would like to change. +Pull requests are welcome for any feature or a bug fix. For major changes, please open an issue first to discuss what you would like to change. ## Development -We use multi stage build with docker. Simply run following commands. +To develop you need 2 terminals for the front and the backend of PerPlexed ```bash -docker build -t perplexed . -docker run --name perplexed -p 3000:3000 -e PLEX_SERVER=http://your-plex-server:32400 perplexed +# Terminal 1 +cd frontend +npm start + +# Terminal 2 +cd backend +PLEX_SERVER=http://plex-server:32400 npm start ```