JellyfinWishlistApp/README.md

33 lines
764 B
Markdown
Raw Normal View History

2024-10-26 17:15:26 +00:00
# Jellyfin Wishlist App
## About
## Backend
The backend is located in the `be` folder.
2024-10-26 17:19:41 +00:00
When it runs, it generates/updates a database that contains all the existing items of the specified jellyfin library.
2024-10-26 17:15:26 +00:00
2024-10-26 17:19:41 +00:00
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.
2024-10-26 17:15:26 +00:00
### System requirements:
* node 18.18.0 or higher
* yarn 1.22.19 or higher
### Installation:
```
cd be
yarn install
2024-10-26 17:19:41 +00:00
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
```
2024-10-26 17:15:26 +00:00
yarn start
```
This will install the node dependencies and run the program.
## Frontend
WIP