Skip to content
This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

Commit

Permalink
Update Frontend README.md (#215)
Browse files Browse the repository at this point in the history
* update ReadMe

* add Frontend Struktur

* update ReadMe
  • Loading branch information
Jstn2004 authored Jun 11, 2024
1 parent 06e0bc7 commit 7f05259
Showing 1 changed file with 65 additions and 14 deletions.
79 changes: 65 additions & 14 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -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.
---

0 comments on commit 7f05259

Please sign in to comment.