prettyplayerapi/README.md

17 lines
512 B
Markdown

# Pretty Player API
Kotlin Spring Boot based REST service for the Pretty Player
# Environment Variables
* `ALBUM_ROOT_DIR` = Directory where the albums of mp3s can be found
* `ALBUM_ART_ROOT_DIR` = Directory where the album art can be cached for later
# TODO
* Add in DB like SQLite where the DB can be written to disk easily, and the DB can run in memory.
* Allows for instant ready, while having new albums added async.
# API Documentation
* http://localhost:8080/swagger-ui/index.html