From f2cb9b8f2e5bd2e369fc441968d9900c28b147d5 Mon Sep 17 00:00:00 2001 From: Nikhil Nawgiri Date: Sat, 26 Oct 2024 19:15:26 +0200 Subject: [PATCH] Add README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..e6a9b5e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Jellyfin Wishlist App +## About + +## Backend +The backend is located in the `be` folder. + +When running it, it generates or updates a database that contains all the existing items of the jellyfin library. + +The API of the backend allows the frontend to check for existing or requested items. It also allows the frontend add requested items to the database. + +### System requirements: +* node 18.18.0 or higher +* yarn 1.22.19 or higher + +### Installation: +``` +cd be +yarn install +yarn start +``` +This will install the node dependencies and run the program. + +## Frontend +WIP