jakob/karaokatalog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Document in README how to launch web app

Browse Source
This commit is contained in:
Jakob Moser 2025-06-22 15:15:32 +02:00
parent d114672681
commit ee8215e7bc
Signed by: jakob
GPG Key ID: 3EF2BA2851B3F53C
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -2,10 +2,11 @@
Tools to manage an UltraStar DX song library. Features include:
1. Deduplication
2. Organization
3. Recoding
4. Jsonification
1. Web-based catalogue UI
2. Deduplication
3. Organization
4. Recoding
5. Jsonification
## Setup
@ -23,6 +24,18 @@ We assume that your song library is stored at `$SONG_LIBRARY`. Replace this plac
export SONG_LIBRARY=/path/to/library
```
### Web-based catalogue UI
**Launch server for a web-based UI to browse the catalogue**, supporting to create a list of favorites.
ℹ️ This is completely risk-free, as it does not change files.
```bash
python3 -m karaokatalog.ui.serve $SONG_LIBRARY
```
To speed up the start, use jsonification to create and persist a JSON of all songs in the library root dir before starting this UI.
### Deduplication
**Find and delete exactly duplicated songs**, i.e., songs with the same title and artist that also consist of exactly the same files in the directory.