Skip to content

Commit 22859fb

Browse files
author
Piotr Kubicki
committed
docs: added HELP.md
1 parent cb59c05 commit 22859fb

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

HELP.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Read Me First
2+
The following was discovered as part of building this project:
3+
4+
* The original package name 'com.capgemini.training.appointment-booking-app' is invalid and this project uses 'com.capgemini.training.appointment_booking_app' instead.
5+
6+
# Getting Started
7+
8+
### Reference Documentation
9+
For further reference, please consider the following sections:
10+
11+
* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
12+
* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/3.4.3/maven-plugin)
13+
* [Create an OCI image](https://docs.spring.io/spring-boot/3.4.3/maven-plugin/build-image.html)
14+
* [Spring Boot DevTools](https://docs.spring.io/spring-boot/3.4.3/reference/using/devtools.html)
15+
* [Spring Web](https://docs.spring.io/spring-boot/3.4.3/reference/web/servlet.html)
16+
* [Spring Security](https://docs.spring.io/spring-boot/3.4.3/reference/web/spring-security.html)
17+
* [Spring Data JPA](https://docs.spring.io/spring-boot/3.4.3/reference/data/sql.html#data.sql.jpa-and-spring-data)
18+
* [Spring Boot Actuator](https://docs.spring.io/spring-boot/3.4.3/reference/actuator/index.html)
19+
* [Flyway Migration](https://docs.spring.io/spring-boot/3.4.3/how-to/data-initialization.html#howto.data-initialization.migration-tool.flyway)
20+
21+
### Guides
22+
The following guides illustrate how to use some features concretely:
23+
24+
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
25+
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
26+
* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
27+
* [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
28+
* [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
29+
* [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
30+
* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
31+
* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
32+
33+
### Maven Parent overrides
34+
35+
Due to Maven's design, elements are inherited from the parent POM to the project POM.
36+
While most of the inheritance is fine, it also inherits unwanted elements like `<license>` and `<developers>` from the parent.
37+
To prevent this, the project POM contains empty overrides for these elements.
38+
If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.
39+

0 commit comments

Comments
 (0)