Skip to content

INSTALL.md

Latest commit

 

History

History
executable file
·
145 lines (104 loc) · 9.88 KB

INSTALL.md

File metadata and controls

executable file
·
145 lines (104 loc) · 9.88 KB

WatchList can be run as a regular web application, a Progressive Web Application (PWA) or in a Docker container.

WatchList explanation

WatchList - WatchList is used to refer to the log that you add to record a movie or TV show that you have watched. You would usually add the date you started watching it, when you finished watching it, where you watched it and your rating of the movie/show.

Items - The record of the movie or TV show. You would only add a WatchListItem once to add a specific movie/tv show or special. The WatchListItem includes information like the name of the movie/show, type (movie/TV show/special), link to IMDB and image from IMDB. By default WatchList Items are hidden and you only see WatchList which shows what you have watched. You can show WatchList items by clicking on the Settings gear and showing it in Visible Sections.

WatchList sections

The application has 5 different sections:

WatchList: These are the records where you add a record any time you watch something.

Items: These are the records that contain the movie, TV show or special which you only add once and then add a record in WatchList where you select the WatchListItem

IMDB Search: Search IMDB and add the result in WatchList

WatchList Stats: Stats of the movies and shows that you have watched over time

Admin: If you are an administrator, you will have access to the admin section where you can manage users, add sources and add types.;

Tips

There are different options available in WatchList. Some of options are only available in certain tabs.

These options are available at the bar at the top of WatchList:

Still Watching - When you add a WatchList, if you do not enter an end date, WatchList will consider that record to be "still watching" whih means that you are still watching that movie/show. When "Still Watching" is enabled, you will only see movies or shows that do not have an end date. Turn this off to see everything that you have already watched. This is available in the WatchList tab

Source - You can filter WatchList by the source where you watched the movie or show at (lke Netflix, Amazon etc) by clicking on the Settings and selecting from the Source dropdown.

Type - You can also filter by Type by clicking on the Settings and selecting from the Type dropdown.

Sort By - Sort WatchList or WatchList items

Sort Order - Sort direction which is ascending or descending

These options are available in Settings:

Visible Sections - All of the sections except for WatchList can be hidden or shown. Tap on an empty area under Visible Section to show a section.

Dark Mode - Toggle dark or light mode. This is on by default.

Archived - If you add a WatchList record and decide not to continue watching the movie or TV show, you can archive that WatchList record. The WatchList record will not be visible any more in WatchList. If you want to find it again, enable the "Archived" toggle.

Auto Add - After you add a WatchListItem, if you want to immediately add a WatchList record to record when you watched a movie or show, enable this feature. If it is off, you will need to click on the plus sign in WatchList to add a new record.

No Image (Only available in Items) - If you add a WatchList Item record for a movie or TV show and the image does not display, go to Items, then enable "No Image" to see Items with missing images.

Requirements: Node 18.19.1 or higher

Installation

  1. Download the latest release from the releases and extract the zip
  2. Edit .env and set SECRET. It needs to be a long, secure password that will be used to encrypt your database. If you lose this secret, there is no way to recover it and you will not be able to use your WatchList database.
  3. Optional: See "Searching IMDB" to enable searching IMDB or "Recommendations" to get movie & TV show recommendations.
  4. Optional: Edit WatchListSources and WatchListTypes as needed if you want to remove any existing sources and types.
  5. Run node server.js to start the server.
  6. See "Setup up admin user account" below.

Build from source

  1. Check out the source from Github and go to the root directory of the project.
  2. Edit .env and set SECRET. It needs to be a long, secure password that will be used to encrypt your database. If you lose this secret, there is no way to recover it and you will not be able to use your WatchList database.
  3. Optional: See "Searching IMDB" to enable searching IMDB or "Recommendations" to get movie & TV show recommendations.
  4. Optional: Edit WatchListSources and WatchListTypes as needed if you want to remove any existing sources and types.
  5. Run npm install
  6. Run npm run build
  7. If you use Windows run npm run deploy-windows, otherwise run npm run deploy-unix
  8. Go to the standalone directory cd .next/standalone
  9. Run node server.js
  10. See "Setup up admin user account" below.

Docker

  1. Edit database.json and look for "SetupComplete" and make sure it is set to true. If not, see "Setup up admin user account" below.
  2. If you downloaded WatchList from the releases section of GitHub, download Docker/Dockerfile from the WatchList repo.
  3. Build the Docker image using the Dockerfile: docker buildx build . -t watchlist
  4. If you downloaded WatchList from the releases section of GitHub, download docker-compose.yml from the WatchList repo.
  5. Edit docker-compose.yml and update the volume path to database.json as needed and your network name to match your Docker network. You can create a docker network if you haven't done so already with the command docker network create YourNetworkName.
  6. Build the Docker container: docker-compose up -d.

Setup up admin user account

  1. Visit http://localhost:3000 in your browser. You should see the Setup page to set up a new account. This account will automatically be created as a WatchList admin account.
  2. Enter the following fields:
    • Name: Name for the new admin account
    • Username: New user name
    • Password: Password that is complex. The password requirements are: 1 lowercase alphabetical character, 1 uppercase alphabetical character, 1 numeric, 1 special char, 8 chars long minimum.
  3. Once you click on "Create the new account", you should see a message that says that the account creation was successfull. You should now be redirected back to the Login page at /Login.
  4. Login using the credentials that you created above.
  5. After completing this setup up, you should have a file name database.json. This is your WatchList database. Make sure to back up this file from time to time.

Searching IMDB

WatchList will allow you to search for a movie or tv show on IMDB.com. To do this, you need to create a free RAPIDAPI Key. Using RapidAPI allows searching with more specific filters by Actor, Director, Genre and many more filters.

Note: RapidAPI allows you 1000 free searches per month. In order for this API to work, you have to "subscribe" by adding your credit card with RapidAPI. It appears to work similarly to Amazon where they won't charge you if you do not go over your allotted API usage. If you do not add a credit card, the API will return an "Unsubscribed" error when you try to use it. I have never been charged for my usage. Once you have used 1000 searches, you will receive an error that you have exceeded your daily usage.

  1. Visit RapidAPI and create a free account.
  2. Click on "My APIs" at the top right
  3. Click on "Add New API" at the top right
  4. Name your API, give it a description and select a category. For "Specify Using" make sure UI is selected
  5. Click on "Add API" button to save it
  6. On the next page, enter a short description and click on Save
  7. Click on the down arrow next to your application name and select Security underneath the sub menu
  8. Click on the eye icon to show your API key and copy it to the clipboard.
  9. Edit .env and set RAPIDAPIKEY with this API key.

Recommendations

You can get recommendations from a movie or TV show. This requires an api key from themoviedb.com which is completely free and does not require you to add a credit card.

  1. Visit TheMovieDB and create a free account.
  2. Click on the avatar icon at the top right and go to settings
  3. Click on API
  4. Copy the "API Read Access Token"
  5. Edit .env and set RECOMMENDATIONSAPIKEY with this API key.

Progressive Web Application (PWA).

WatchList can be used as a desktop application by installing it as a PWA.

Google Chrome: Click on the icon that looks like a monitor with a down arrow in it in the right side of the address bar. Microsoft Edge: Click on the L shape with a plus in it in the right side of the address bar. Mozilla Firefox: Firefox does not support PWAs and you will need to use one of the 2 browsers above to install WatchList as a PWA.

Resetting Admin password

If you cannot log into WatchList with the admin account, you can reset the password for the admin account directly in the database.

  1. Edit database.json
  2. Go to the Users section
  3. Expand the first user account with UserID 1
  4. Change the password to "U2FsdGVkX18kOsqQBr1pTD01Xl7T+aPG7EQCl14pzLc="
  5. Log into WatchList with the password "watchlist" without quotes.
  6. Go to the admin section and change your password.

Development

Please use Github issue tracker to suggest ideas.

Caching only works over https. To test caching with the dev server:

  1. Install mkcert:
    • Linux: apt install mkcert
    • macOS: brew install mkcert
    • Windows: choco install mkcert
  2. Install local CA: mkcert -install
  3. Generate dev certs: mkcert watchlist.demo.dev

Known Issues:

If you search RapidAPI for a movie or show that is pretty new, you may not be able to find it when searching and will have to add a WatchList Item manually. This happens because RapidAPI does not have new movies or shows in their database right away.