aarbit/prettyplayerapi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates readme, adds Swagger doc

Browse Source
This commit is contained in:
aarbit 2024-06-25 16:12:18 -05:00
parent db994d92cd
commit 9ff2de36df
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,4 +5,13 @@ Kotlin Spring Boot based REST service for the Pretty Player
# Environment Variables # Environment Variables
* `ALBUM_ROOT_DIR` = Directory where the albums of mp3s can be found * `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 * `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

3
build.gradle.kts
View File

@ -8,7 +8,7 @@ plugins {
} }
group = "net.halfbinary" group = "net.halfbinary"
version = "0.0.11-SNAPSHOT" version = "0.0.12-SNAPSHOT"
java { java {
sourceCompatibility = JavaVersion.VERSION_21 sourceCompatibility = JavaVersion.VERSION_21
@ -44,6 +44,7 @@ dependencies {
implementation("org.slf4j:slf4j-api:$slf4jApiVersion") implementation("org.slf4j:slf4j-api:$slf4jApiVersion")
implementation("ch.qos.logback:logback-core:$logbackVersion") implementation("ch.qos.logback:logback-core:$logbackVersion")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion")
implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0")
developmentOnly("org.springframework.boot:spring-boot-devtools") developmentOnly("org.springframework.boot:spring-boot-devtools")
annotationProcessor("org.springframework.boot:spring-boot-configuration-processor") annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
testImplementation("org.springframework.boot:spring-boot-starter-test") testImplementation("org.springframework.boot:spring-boot-starter-test")