Merge pull request #3 from ABI-Deployment-Thesis/ruiar/add-readme

feat(readme): add readme

.dockerignore

@@ -1,4 +1,5 @@
-./node_modules
+node_modules
 Dockerfile
 .dockerignore
-docker-compose.yml
+docker-compose.yml
+docker-compose.yaml

Makefile

@@ -0,0 +1,7 @@
+# Variables
+IMAGE_NAME=abi-deployment-thesis/access-control
+TAG=dev
+
+# Build the Docker image
+build:
+	docker build -t $(IMAGE_NAME):$(TAG) .

README.md

@@ -0,0 +1,42 @@
+<div align="center">
+    <a href="https://www.eng.uminho.pt" target="_blank"><img src="https://i.imgur.com/mOynow9.png" alt="Engineering School"/></a>
+    <a href="https://www.uminho.pt" target="_blank"><img src="https://i.imgur.com/1gtSAGM.png" alt="University Of Minho"/></a>
+    <br/>
+    <a href="http://www.dsi.uminho.pt" target="_blank">
+        <strong>Information Systems Department</strong>
+    </a>
+    <br/>
+    <br/>
+    <a href="https://github.com/ABI-Deployment-Thesis/access-control/actions"><img alt="Tests Status" src="https://github.com/ABI-Deployment-Thesis/access-control/actions/workflows/tests.yaml/badge.svg"></a>
+    <a href="https://github.com/ABI-Deployment-Thesis/access-control/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/ABI-Deployment-Thesis/access-control"></a>
+    <a href="https://github.com/ABI-Deployment-Thesis/access-control/blob/main/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/ABI-Deployment-Thesis/access-control"></a>
+</div>
+
+<h2 align="center">ABI Deployment Thesis - Access Control</h2>
+
+Welcome to the access-control repository! This project is a key part of a master's thesis at the University of Minho. It's a Proof of Concept for a proposed architecture designed to deploy and integrate intelligent models within ABI (Adaptive Business Intelligence) systems.
+
+**This repository provides the microservice responsible for user management and authentication.**
+
+For a detailed explanation of the proposed architecture and its deployment strategy, please refer to the published article: [Architecture proposal for deploying and integrating intelligent models in ABI](https://www.sciencedirect.com/science/article/pii/S1877050923022445).
+
+## Quick Start
+
+- For setup instructions and initial configuration, please follow the guidelines provided in the [infrastructure repository](https://github.com/ABI-Deployment-Thesis/component-core?tab=readme-ov-file#quick-start).
+
+## Networking
+
+- Ingress
+  - Exposes a REST API on the default port 3001.
+- Egress
+    - None.
+- Both
+    - Communicates with MongoDB to save and retrieve data.
+
+## Author
+
+- Rui Gomes ([LinkedIn](https://www.linkedin.com/in/ruigomes99))
+
+## License
+
+- [MIT](https://choosealicense.com/licenses/mit/)

http/loader.js

@@ -10,7 +10,7 @@ app.use((req, res, next) => {
 })
 
 app.get('/', (req, res) => {
-    res.json({ message: 'Hello World' })
+    res.status(200).json({ message: 'Hello World' })
 })
 
 app.use(express.json())