From bc4203c1d1b8470db2ce4abb5e04529a4e8dc4d8 Mon Sep 17 00:00:00 2001 From: Nikhil Nawgiri Date: Sat, 26 Oct 2024 19:19:41 +0200 Subject: [PATCH] Update README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6a9b5e..34e02f8 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ ## 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. +When it runs, it generates/updates a database that contains all the existing items of the specified 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. +The API of the backend allows the frontend to check for existing or requested items. It also allows the frontend to add requested items to the database. ### System requirements: * node 18.18.0 or higher @@ -16,6 +16,14 @@ The API of the backend allows the frontend to check for existing or requested it ``` cd be yarn install +cp config.ts.example config.ts +``` + +Edit the config.ts: +* Add the API token: Can be created in the Jellyfin dashboard -> API keys +* Add the API base: The address of the Jellyfin instance + +``` yarn start ``` This will install the node dependencies and run the program.