Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ipmake authored Jan 4, 2025
1 parent cb5dc93 commit 20f4ef7
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
```

0 comments on commit 20f4ef7

Please sign in to comment.