From 64449edd905dd166824bdce7b586ca11ed6b31d2 Mon Sep 17 00:00:00 2001
From: CemAdg <cem.akdag@hotmail.de>
Date: Tue, 29 Jun 2021 11:38:12 +0200
Subject: [PATCH] README updated

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index e69de29..766579f 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+# IoT Hackathon
+
+## ZRoom App - Two worlds, one room
+
+The IoT Hackathon has the goal to find solutions for the typical problems during hybrid-lectures, e.g. the professor "forgets" the remote students or the professor has to interrupt the lecture on site and carry out additional activities in order to interact with remote students. More details about the problems and our concepts to solve them can be found in the [Wiki]( (https://gitlab.reutlingen-university.de/SCCA/ZRoom_App/-/wikis/1-Teamaufteilung)
+
+## About the Stack
+
+As a MVP of our concepts, we implemented a full stack web application with different software environments and components for the frontend and backend. More conceptional details about the software architecture and the prototyp can be found [here](https://gitlab.reutlingen-university.de/SCCA/ZRoom_App/-/wikis/3-Vorgehen-Prototyp-Implementierung)
+
+### Backend
+
+The `./backend` directory contains a Flask web server with API endpoints.
+
+[View the README.md within ./backend for more details.](./backend/README.md)
+
+### Frontend
+
+The `./frontend` directory contains a React frontend to send HTTP requests to the Flask server. 
+
+[View the README.md within ./frontend for more details.](./frontend/README.md)
-- 
GitLab