e63adb964d
- backend/workspaces/backend/ → backend/ - backend/workspaces/frontend/ → frontend/ - backend/.devcontainer/ + .vscode/ → repo root (where VS Code expects them) - loose scripts/SQL files → scripts/ - replace nested git repo with single repo at project root - update docker-compose.yml build context and devcontainer.json path - add root .gitignore Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
50 lines
3.1 KiB
Markdown
50 lines
3.1 KiB
Markdown
# Getting Started
|
|
|
|
### Reference Documentation
|
|
For further reference, please consider the following sections:
|
|
|
|
* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
|
|
* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/4.0.0/maven-plugin)
|
|
* [Create an OCI image](https://docs.spring.io/spring-boot/4.0.0/maven-plugin/build-image.html)
|
|
* [Docker Compose Support](https://docs.spring.io/spring-boot/4.0.0/reference/features/dev-services.html#features.dev-services.docker-compose)
|
|
* [Spring Web](https://docs.spring.io/spring-boot/4.0.0/reference/web/servlet.html)
|
|
* [Rest Repositories](https://docs.spring.io/spring-boot/4.0.0/how-to/data-access.html#howto.data-access.exposing-spring-data-repositories-as-rest)
|
|
* [Spring Session for JDBC](https://docs.spring.io/spring-session/reference/)
|
|
* [Spring Security](https://docs.spring.io/spring-boot/4.0.0/reference/web/spring-security.html)
|
|
* [JDBC API](https://docs.spring.io/spring-boot/4.0.0/reference/data/sql.html)
|
|
* [Spring Data JPA](https://docs.spring.io/spring-boot/4.0.0/reference/data/sql.html#data.sql.jpa-and-spring-data)
|
|
* [Spring Boot Actuator](https://docs.spring.io/spring-boot/4.0.0/reference/actuator/index.html)
|
|
|
|
### Guides
|
|
The following guides illustrate how to use some features concretely:
|
|
|
|
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
|
|
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
|
|
* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
|
|
* [Accessing JPA Data with REST](https://spring.io/guides/gs/accessing-data-rest/)
|
|
* [Accessing Neo4j Data with REST](https://spring.io/guides/gs/accessing-neo4j-data-rest/)
|
|
* [Accessing MongoDB Data with REST](https://spring.io/guides/gs/accessing-mongodb-data-rest/)
|
|
* [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/)
|
|
* [Accessing Relational Data using JDBC with Spring](https://spring.io/guides/gs/relational-data-access/)
|
|
* [Managing Transactions](https://spring.io/guides/gs/managing-transactions/)
|
|
* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
|
|
* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
|
|
|
|
### Docker Compose support
|
|
This project contains a Docker Compose file named `compose.yaml`.
|
|
In this file, the following services have been defined:
|
|
|
|
* postgres: [`postgres:latest`](https://hub.docker.com/_/postgres)
|
|
|
|
Please review the tags of the used images and set them to the same as you're running in production.
|
|
|
|
### Maven Parent overrides
|
|
|
|
Due to Maven's design, elements are inherited from the parent POM to the project POM.
|
|
While most of the inheritance is fine, it also inherits unwanted elements like `<license>` and `<developers>` from the parent.
|
|
To prevent this, the project POM contains empty overrides for these elements.
|
|
If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.
|
|
|