remove graalvm (for now) cleanup config, add to README.md (#9)

* remove graalvm (for now) cleanup config, add to README.md

* incorp review comments & fix .gitignore

and bump spring boot version to match readme

* issue #1: provide shell script to prune docker resources of mongo-db

* newlines at eof

.dev/remove-mongo-volume.sh

@@ -0,0 +1,6 @@
+echo "Really delete all flashcards data - including user data ? [y/n]" && read choice
+[[ $choice = "y" ]] || exit;
+
+echo "Deleting container and volume ..."
+docker ps -a --format '{{.Names}}' | grep '^flashcards' | xargs docker rm -f
+docker volume ls -q --filter name=flashcards | xargs docker volume rm

.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+insert_final_newline = true

.github/workflows/gradle.yml

@@ -21,9 +21,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up JDK 21
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v4
       with:
         java-version: '21'
         distribution: 'temurin'

.gitignore

@@ -9,10 +9,10 @@ out/
 *.p12
 
 ### IntelliJ IDEA ###
-.idea/modules.xml
 .idea/libraries/
 .idea/sonarlint/
-!.idea/compiler.xml
+.idea/modules/
+.idea/*.xml
 
 ### Mac OS ###
 .DS_Store

README.md

@@ -2,18 +2,36 @@
 
 Project idea came up in the Hyperskill community team and will be realized by this team.
 
+## Usage
+
+### Run the app
+To run the application including startup of MongoDB container, use the stored Run configuration in IntelliJ IDEA.
+You can transfer it to the Service tool window for convenience via Add Service -> Run configuration -> Spring.
+
+Alternatively run the following command:
+
+```shell
+./gradlew bootRun
+```
+### Purge docker resources (mongo-data volume and mongo container)
+Take care, running this  script deletes all persistent data of the mongo container.
+```shell
+.dev/remove-mongo-volume.sh
+```
+
 ## Technology / External Libraries
 
 - Java 21
 - Spring Boot 3.2.1
-- Support for Native image on GraalVM
 - Mongo DB via docker-compose
 - Vue 3 SPA-Frontend using component framework Vuetify 3
 - Packaging with Vite
 - Lombok
 - Testcontainers
 - Gradle 8.5
 
+[//]: # (- Support for Native image on GraalVM)
+
 ## Program description
 
 The application represents a digital flashcard app, that allows to create, store and retrieve flashcards via REST-endpoints.

gradle/libs.versions.toml

@@ -1,6 +1,5 @@
 [versions]
-spring-boot = "3.2.0"
+spring-boot = "3.2.1"
 spring-dependency-management = "1.1.4"
-graalvm-buildtools = "0.9.28"
 node-gradle = "7.0.1"
-node-js = "21.5.0"
+node-js = "21.5.0"

server/build.gradle.kts

@@ -1,8 +1,9 @@
+import org.springframework.boot.gradle.tasks.run.BootRun
+
 plugins {
     application
     id("org.springframework.boot") version libs.versions.spring.boot
     id("io.spring.dependency-management") version libs.versions.spring.dependency.management
-    id("org.graalvm.buildtools.native") version libs.versions.graalvm.buildtools
 }
 
 group = "org.hyperskill.community"
@@ -43,6 +44,10 @@ dependencies {
     testImplementation("org.testcontainers:mongodb")
 }
 
+tasks.withType<BootRun> {
+    workingDir = rootProject.projectDir
+}
+
 tasks.withType<Test> {
     useJUnitPlatform()
 }