update README.md

This commit is contained in:
2026-02-04 13:48:23 +01:00
parent d2f62e56f2
commit 975d3ed433
2 changed files with 48 additions and 41 deletions

View File

@@ -4,18 +4,32 @@ This project is a full-stack web application Template combining **ASP.NET Core**
## 🛠️ Technologies Used
- **Backend:** ASP.NET Core (.NET 9)
- **Backend:** ASP.NET Core (.NET 10)
- **Frontend:** Angular
- **API Documentation:** Swagger (Swashbuckle)
## 🔐 Authentication (Register & Login)
The template includes a preconfigured user registration and authentication flow, designed as a solid baseline for production-ready applications.
- **Register:**
Creation of new user accounts via a dedicated API endpoint with server-side validation and secure password hashing.
- **Login:**
Token-based authentication using JWT (JSON Web Token). Upon successful authentication, a token is issued for authorized API access.
- **Authorization:**
Protected backend endpoints and frontend routes are secured using role- or policy-based access control.
The authentication architecture is secure, extensible, and aligned with enterprise best practices.
## 🚀 Getting Started
### Prerequisites
- [.NET 9 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
- [.NET 10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
- [Node.js (LTS)](https://nodejs.org/)
@@ -48,34 +62,27 @@ This project is a full-stack web application Template combining **ASP.NET Core**
---
## 🧪 Angular-Tests ausführen (Wie mache ich Tests in Angular?)
## 🧪 Running Angular Tests
Die Angular-Frontend-Tests sind mit Karma + Jasmine eingerichtet. Alle Testdateien enden auf `.spec.ts` und liegen neben den jeweiligen Komponenten/Services im Ordner `src/ClientApp/src/`.
Angular frontend tests are set up using Karma + Jasmine. All test files follow the `.spec.ts` naming convention and are located alongside their respective components and services in `src/ClientApp/src/`.
### Schnellstart
### Quick Start
1. Abhängigkeiten installieren (falls noch nicht erledigt):
```bash
cd src/ClientApp
npm install
```
2. Tests im Watch-Modus starten (öffnet den Browser, ideal für Entwicklung):
```bash
npm test
cd src/ClientApp
npm test
```
### Headless/CI und Coverage
- Einmalige Testausführung mit Coverage-Bericht (headless):
```bash
cd src/ClientApp
npm run test:coverage
```
Der Coverage-Report wird unter `src/ClientApp/coverage/` erzeugt (HTML-Report in `index.html`).
The coverage report is generated under `src/ClientApp/coverage/` (HTML-Report in `index.html`).
- CI-freundliche Ausführung in Chrome Headless inklusive Coverage:
```bash
cd src/ClientApp
npm run test:ci
```
Hinweis: Für Headless-Tests muss eine Chrome/Chromium-Laufzeit auf der Maschine vorhanden sein.
Note: For headless tests, a Chrome/Chromium runtime must be present on the machine.