Add README

This commit is contained in:
Nikhil Nawgiri 2024-10-26 19:15:26 +02:00
parent e1dbe4d7e4
commit f2cb9b8f2e

View file

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