summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..acacb86
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Based on [amigoscode Spring Boot
+tutorial](https://www.youtube.com/watch?v=9SGDpanrc8U)
+
+"Minimal" example for a Spring Boot RESTful API.
+
+`student` is a package that tries to implement a RESTful API with minimal
+boilerplate code. It uses Spring Data JPA and lombok.
+
+Dependencies are managed by Maven.
+
+It also depends on a Postgres DB, as specified in the `application.properties`
+file. An important property there is `spring.jpa.hibernate.ddl-auto`.
+Available values include `none` (production), `update` (develop), `create-drop`
+(testing).
+
+2022-06-23