version 1.0

2025-07-12 19:06:23 +02:00
parent d3af3b6433
commit 61d4a3a1ca
115 changed files with 185766 additions and 95 deletions
--- a/HELP.md
+++ b/HELP.md
@@ -0,0 +1,46 @@
+# Read Me First
+
+The following was discovered as part of building this project:
+
+* No Docker Compose services found. As of now, the application won't start! Please add at least one service to the
+  `compose.yaml` file.
+
+# Getting Started
+
+### Reference Documentation
+
+For further reference, please consider the following sections:
+
+* [Official Gradle documentation](https://docs.gradle.org)
+* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/3.5.3/gradle-plugin)
+* [Create an OCI image](https://docs.spring.io/spring-boot/3.5.3/gradle-plugin/packaging-oci-image.html)
+* [Spring Data JPA](https://docs.spring.io/spring-boot/3.5.3/reference/data/sql.html#data.sql.jpa-and-spring-data)
+* [Spring Boot DevTools](https://docs.spring.io/spring-boot/3.5.3/reference/using/devtools.html)
+* [Docker Compose Support](https://docs.spring.io/spring-boot/3.5.3/reference/features/dev-services.html#features.dev-services.docker-compose)
+* [Spring Security](https://docs.spring.io/spring-boot/3.5.3/reference/web/spring-security.html)
+* [Vaadin](https://vaadin.com/docs)
+
+### Guides
+
+The following guides illustrate how to use some features concretely:
+
+* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
+* [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
+* [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
+* [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
+* [Creating CRUD UI with Vaadin](https://spring.io/guides/gs/crud-with-vaadin/)
+
+### Additional Links
+
+These additional references should also help you:
+
+* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle)
+
+### Docker Compose support
+
+This project contains a Docker Compose file named `compose.yaml`.
+
+However, no services were found. As of now, the application won't start!
+
+Please make sure to add at least one service in the `compose.yaml` file.
+