Merge remote-tracking branch 'origin/main'

.github/workflows/main.yml

@@ -3,6 +3,9 @@ name: Run unit tests
 on:
   push:
     branches: [ "main" ]
+    paths:
+      - '**/*'
+      - '!README.md'
 
 jobs:
   build-test-package:
@@ -15,7 +18,7 @@ jobs:
     - name: Start MongoDB
       uses: supercharge/[email protected]
       with:
-        mongodb-version: ${{ matrix.mongodb-version }}
+        mongodb-version: 7.0.6
 
     - name: Set up JDK 21
       uses: actions/setup-java@v3

README.md

@@ -1,2 +1,30 @@
-# food-ordering-services
-Food ordering services example
+# Food Ordering System 📱 🚙 🍕
+
+### TODO:
+- RestaurantsAPI
+- OrdersProcessingAPI
+
+## Overview
+This project serves as an example of food ordering system using a microservice approach.
+
+## UserManagementAPI
+Simple microservice for managing users, built using Spring Boot and Kotlin.
+
+### How to run
+
+```console
+~$ cd UserManagementAPI
+~$ docker-compose up
+```
+
+UserManagementAPI will be avaiable on ```localhost:8080/api/v1```. Access Swagger ```http://localhost:8080/api/v1/swagger-ui/index.html```.
+
+### Unit Tests
+Before running unit tests, ensure that you have a local MongoDB instance running on ```localhost:27017```.
+
+### Endpoints
+- GET /api/v1/health
+- GET /api/v1/users
+- GET /api/v1/users/{id}
+- PUT /api/v1/users/{id}
+- DELETE /api/v1/users/{id}