From 7f0525938401b7c0185c88d11b83c02498e3df7e Mon Sep 17 00:00:00 2001
From: Justin Hubert <135236159+Jstn2004@users.noreply.github.com>
Date: Tue, 11 Jun 2024 10:56:17 +0200
Subject: [PATCH] Update Frontend README.md (#215)

* update ReadMe

* add Frontend Struktur

* update ReadMe
---
 frontend/README.md | 79 ++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 65 insertions(+), 14 deletions(-)

diff --git a/frontend/README.md b/frontend/README.md
index 73cfd04..023f31b 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,27 +1,78 @@
-# Frontend
+# 🖥️Frontend DuoGradus
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.8.
+|                  |                        |
+| ---------------- | ---------------------- |
+| **Sprache**          | **Typescript, HTML, SCSS** |
+| **Framework**        | **Angular**                |
+| **Version**          | **17.0.8.**                |
+| **Packetverwaltung** | **npm**                    |
+### Voraussetzungen
+---
+- NodeJS mit dem Node Package Manager (npm) ist installiert
+- Angular CLI (`npm install -g @angular/cli`)
 
-## Development server
+### 🛠️ Projekt Setup
+---
+Um die notwendigen Abhängigkeiten zu installieren, führe `npm install` in der Kommandozeile aus
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+### 🚀 Projekt starten
+---
+Um das Frontend Lokal anzeigen zu lassen, führe `ng serve` in der Kommandozeile aus. Navigiere in deinem Browser zu  `http://localhost:4200/` um die Webseite anzuzeigen. Werden dabei Änderungen vorgenommen aktualisiert sich die Seite  automatisch.
 
-## Code scaffolding
+### 🛡️Unit Tests starten
+---
+Zum Ausführen der Unit Tests, führe `ng test` in der Kommandozeile aus. Dabei werden die Test im Terminal angezeigt. Um sich die Tests im Browser übersichtlicher anzeigen zu lassen navigiere zu `http://localhost:9876/`. 
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+### 🖊️ Frontend bearbeiten
+---
+#### Schritte zum Bearbeiten des Frontends:
 
-## Build
+1. Erstelle eine neue Feature-Branche:
+    ```
+    git checkout -b feature/NeuesFeature
+    ```
+    
+2. Führe die gewünschten Änderungen durch (z.B. Erzeugen einer neuen Komponente):
+    ```
+    ng generate component name
+	```
+	
+3. Committe die Änderungen:
+    ```
+    git add .
+    git commit -m "Füge neue Komponente hinzu"
+	```
+	
+4. Push die Feature-Branche:
+    ```
+    git push origin feature/NeuesFeature
+    ```
+    
+5. Erstelle einen Pull Request, um die Änderungen in den Main-Branch zu mergen. 
+6. Nach der Überprüfung und dem Merge des Pull Requests, lösche die Feature-Branche
+    ```
+    git branch -d feature/NeuesFeature
+    git push origin --delete feature/NeuesFeature
+    ```
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+### ❓Support
+---
+Bei Fragen oder Problemen, erstelle bitte ein Issue im [GitHub Repository](https://github.com/SE-TINF22B2/G5-DuoGradus) oder kontaktiere das Frontend-Entwicklerteam: @Jstn2004, @www.Luis
 
-## Running unit tests
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Running end-to-end tests
 
-Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
 
-## Further help
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+
+
+ 
+
+
+
+
+
+
+
+
+---