Skip to content

Installation

danrahn edited this page Mar 9, 2024 · 8 revisions

Prerequisites and Downloading the Project

Pre-built Packages

Pre-built packages are available for some common platforms. If a package is available for your system, you can download the MarkerEditor.vX.X.X-{platform}-{architecture} that matches your system from the latest release and extract the contents to a new folder. If you have been using a previous release, it's recommended to first remove the node_modules folder, and you can overwrite any existing files, as your configuration and backup database won't be affected.

NOTE: Only the Windows x64 package has been heavily vetted. Other platforms only have minimal validation.

Docker

docker run -p 3233:3232 \
           -v /path/to/config:/Data \
           -v /path/to/PlexData:/PlexDataDirectory \
           -it danrahn/intro-editor-for-plex:latest

See configuring Docker for more details.

From Source

If a pre-built package is not available for your system, or want to build the code yourself, you can follow the steps below.

Prerequisites

For this application to run, you need to install Node.js. Either the LTS or Current version will work, though LTS is likely to be more stable. Note that this project does have dependencies on native modules (sqlite3), so if during the installation you are prompted to install tools for native modules, you should choose to do so. If you don't have all the prerequisites already installed (e.g. Visual Studio build tools on Windows), the installation process will take some time.

Download the Project

There are two ways to download this project, via git (recommended), or a direct .zip download.

Git

There are multiple ways to use git to clone a GitHub project, outlined in GitHub's Cloning a repository documentation. Any approach should work, just make a note of where the project is saved on your computer.

Direct Download

If you don't want to set up git, you can download the latest version of the code directly here, or navigate to Code > Download ZIP from the project home page:

image

You can also download the zipped source from a specific release on the releases page.

After downloaded, simply extract it to the location of your choice.

Install Node Packages

Before running Marker Editor, additional dependencies must be installed, outlined in package.json. To install these, open a terminal/command prompt window, navigate to the MarkerEditorForPlex folder, and run npm install.

Click to see Windows commands
C:\Users\Username>cd Documents\Programming

C:\Users\Username\Documents\Programming>git clone https://github.com/danrahn/MarkerEditorForPlex.git
Cloning into 'MarkerEditorForPlex'...
remote: Enumerating objects: 1220, done.
remote: Counting objects: 100% (389/389), done.
remote: Compressing objects: 100% (243/243), done.
remote: Total 1220 (delta 249), reused 272 (delta 146), pack-reused 831
Receiving objects: 100% (1220/1220), 496.45 KiB | 11.03 MiB/s, done.
Resolving deltas: 100% (808/808), done.

C:\Users\Username\Documents\Programming>cd MarkerEditorForPlex

C:\Users\Username\Documents\Programming\MarkerEditorForPlex>npm install

added 110 packages, and audited 111 packages in 2s

7 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

Commands are identical on Linux (and macOS), but a forward slash is used to navigate directories:

Click to see Linux commands
username@DESKTOP:~$ cd Documents/Programming
username@DESKTOP:~/Documents/Programming$ git clone https://github.com/danrahn/MarkerEditorForPlex.git
Cloning into 'MarkerEditorForPlex'...
remote: Enumerating objects: 1220, done.
remote: Counting objects: 100% (389/389), done.
remote: Compressing objects: 100% (243/243), done.
remote: Total 1220 (delta 249), reused 272 (delta 146), pack-reused 831
Receiving objects: 100% (1220/1220), 496.45 KiB | 12.11 MiB/s, done.
Resolving deltas: 100% (808/808), done.

username@DESKTOP:~/Documents/Programming$ cd MarkerEditorForPlex/

username@DESKTOP:~/Documents/Programming/MarkerEditorForPlex$ npm install

added 110 packages, and audited 111 packages in 5s

7 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

Clone this wiki locally