From d8d7e08c901cca52c85baaf83b756d7f06673173 Mon Sep 17 00:00:00 2001
From: "Wagner O. Wutzke" <wagner.wutzke@nordeck.net>
Date: Thu, 20 Feb 2025 11:45:19 -0300
Subject: [PATCH] chore: created readme file

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..643aa74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Open Video Conference (OVC) Backend Documentation
+Java Backend API for DVB Booking Portal
+
+Backend application created using:
+* Spring Boot
+* Spring Web MVC Rest Controllers + Swagger
+* Spring JPA + Hibernate
+* Postgresql DB
+
+## REST API Documentation (OpenAPI 3.0)
+The OVC backend API has an auto-generated Swagger (OpenAPI 3.0) documentation.
+One can see the REST endpoints documentation as a web page in a web-browser.
+
+In order to see the documentation, the backend application must be running.
+The url for that page follows the pattern:
+`https://{{ backend-app-domain }}/swagger-ui/index.html`
+
+For instance, for the integration environment, the url is:
+https://ovc-backend.nordeck.io/swagger-ui/index.html.
+
+## Running the docker containers for DB & App
+```sh
+docker compose build
+docker compose up
+```
+
+## Application health
+We use the Spring Actuator endpoint in order to check if the application is running:
+``` 
+http://{{ backend-app-domain }}/actuator/health
+```
+The response should be:
+```json
+{
+  "status": "UP"
+}
+```