Restructuring

.gitignore

@@ -2,6 +2,8 @@
 db/
 neo4j-data/
 neo4j-data-new/
+observability/
+logs/
 
 # Ignore Gradle project-specific cache directory
 nbproject
@@ -233,7 +235,7 @@ Temporary Items
 ### Gradle ###
 .gradle
 **/build/
-!src/**/build/
+!idoris/**/build/
 
 # Ignore Gradle GUI configuration
 gradle-app.setting
@@ -258,3 +260,4 @@ gradle-app.setting
 *.hprof
 
 # End of https://www.toptal.com/developers/gitignore/api/intellij+all,macos,java,gradle,webstorm+all,git!/.idea/!/db/
+*/build

README.md

@@ -4,18 +4,6 @@
 
 IDORIS is an **Integrated Data Type and Operations Registry with Inheritance System**.
 
-## Cloning this repository
-
-This repository includes files that are stored using Git LFS.
-Please install Git LFS before cloning this repository.
-For more information, see https://git-lfs.com/.
-Then execute the following command to clone this repository:
-
-```
-git lfs install
-git lfs clone https://github.com/maximiliani/idoris.git
-```
-
 ## Installation of Neo4j
 
 IDORIS relies on the Neo4j graph database.
@@ -49,7 +37,7 @@ For macOS, you can install it using Homebrew: ```brew install openjdk@21```.
 
 For Fedora, you can install it using DNF: ```sudo dnf install java-21```.
 
-Configure the [application.properties](src/main/resources/application.properties) file to contain the Neo4j API
+Configure the [application.properties](idoris/main/resources/application.properties) file to contain the Neo4j API
 credentials.
 
 ```
@@ -58,7 +46,8 @@ logging.level.root=INFO
 spring.neo4j.uri=bolt://localhost:7687
 spring.neo4j.authentication.username=neo4j
 spring.neo4j.authentication.password=superSecret
-spring.data.rest.basePath=/api
+# Base path for all REST endpoints
+server.servlet.context-path=/api
 server.port=8095
 idoris.validation-level=info
 idoris.validation-policy=strict
@@ -71,3 +60,11 @@ When Neo4j is running, start IDORIS with the following command:
 ```
 
 You can access the IDORIS API at http://localhost:8095/api.
+
+### API Documentation
+
+IDORIS provides comprehensive API documentation using OpenAPI/Swagger. You can access the API documentation
+at http://localhost:8095/swagger-ui.html when the application is running.
+
+All endpoints support HATEOAS (Hypermedia as the Engine of Application State) and return HAL (Hypertext Application
+Language) responses, making the API self-discoverable.