realestninja/JellyfinWishlistApp
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Nikhil Nawgiri 2024-10-26 19:19:41 +02:00
parent f2cb9b8f2e
commit bc4203c1d1
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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.