Skip to content

README.md

Latest commit

 

History

History
207 lines (153 loc) · 7.86 KB

README.md

File metadata and controls

207 lines (153 loc) · 7.86 KB

(zurück nach oben)

📝 So verwendest du dieses Template

Nachdem du dieses Template über den Button "Use this template" für dein eigenes Repository übernommen hast, führe folgende Schritte durch:

  1. Projektnamen anpassen: Suche im gesamten Projekt nach HighPerformanceTemplate und ersetze es durch den Namen deines Projekts. Dies ist vor allem für die Namespaces und die .sln-Datei wichtig.
  2. Platzhalter ersetzen:
    • Suche und ersetze [DEIN_USER] mit deinem GitHub-Benutzernamen.
    • Suche und ersetze [REPO_NAME] mit dem Namen deines Repositories.
  3. README anpassen: Bearbeite diese README.md, um dein spezifisches Projekt zu beschreiben, und lösche diesen Einführungsabschnitt.

Project Banner

ASP.NET Core High-Performance Template

Ein sofort einsatzbereites Template für moderne ASP.NET Core-Anwendungen mit Blazor, MudBlazor & Fluent UI.

Bug melden · Feature anfragen

Status GitHub Issues GitHub Pull Requests License

📖 Inhaltsverzeichnis
  1. Über das Projekt
  2. Getting Started
  3. Entwicklung & Commands
  4. Testing
  5. CI/CD & DevOps
  6. Mitwirken
  7. Lizenz

💡 Über das Projekt

Dieses Repository dient als hochmodernes Fundament für neue ASP.NET Core-Projekte. Es ist vorbereitet für .NET 10 (aktuell .NET 9) und kombiniert die besten UI-Bibliotheken (MudBlazor und Fluent UI) mit einer robusten Architektur.

✨ Features

  • Dual UI Support:
    • MudBlazor für Material Design.
    • Fluent UI Blazor für Windows 11 Ästhetik.
    • Theme Switcher: Dynamisches Umschalten zwischen den Designs zur Laufzeit.
  • Moderne Architektur:
    • Clean Architecture Ansätze.
    • "Single Class per File" Fokus.
    • Nutzung von GlobalUsings.cs (Barrel Files).
  • Fortschrittliches Testing:
    • Unit Tests mit xUnit.
    • Integration Tests mit WebApplicationFactory.
    • E2E Tests mit Playwright.
  • Entwickler-Erfahrung:
    • Konfiguriert für VS Code und Sublime Text 4.
    • EditorConfig für strenges Linting.
    • Makefile für einfache Befehlssteuerung.

🛠 Technologie Stack

Komponente Technologie / Bibliothek Beschreibung
Core .NET 9 (Ready for 10) Neuestes ASP.NET Core Framework
UI Blazor WebAssembly / Auto Client-seitige Interaktivität
UI Lib MudBlazor Material Design Komponenten
UI Lib Fluent UI Blazor Windows 11 / Office Komponenten
Testing xUnit Unit- & Integration-Tests
Testing Playwright End-to-End Browser Tests
Build Makefile Standardisierte Skripte
CI/CD GitHub Actions Automatisierte Pipelines

📂 Projektstruktur

[REPO_NAME]/
├── .github/                 # GitHub Actions & Dependabot
├── src/                     # Quellcode
│   ├── HighPerformanceTemplate.Host/    # ASP.NET Core API / Server
│   ├── HighPerformanceTemplate.Client/  # Blazor WebAssembly Client
│   └── HighPerformanceTemplate.Shared/  # Gemeinsame DTOs & Interfaces
├── tests/                   # Testprojekte
│   ├── HighPerformanceTemplate.UnitTests/       # xUnit Tests
│   ├── HighPerformanceTemplate.IntegrationTests/# Integrationstests
│   └── HighPerformanceTemplate.E2ETests/        # Playwright E2E Tests
├── .editorconfig            # Coding Style Regeln
├── .gitignore               # Git Ignore Datei
├── Makefile                 # Entwicklungs-Befehle
├── HighPerformanceTemplate.sln # Solution-Datei
└── README.md                # Diese Datei

(zurück nach oben)

🚀 Getting Started

Folge diesen Schritten, um das Projekt lokal aufzusetzen.

Voraussetzungen

Stelle sicher, dass folgende Tools auf deinem System installiert sind:

  • Git
  • .NET 9 SDK (oder neuer)
  • Node.js (benötigt für Playwright)

Entwicklung & Commands

Dieses Projekt nutzt ein Makefile, um häufige Befehle zu vereinfachen.

Befehl Beschreibung Äquivalenter dotnet Befehl
make build Kompiliert die gesamte Solution dotnet build
make run Startet die Host-Anwendung dotnet run --project src/...Host/...Host.csproj
make test Führt alle Tests aus (Unit, Integration) dotnet test
make clean Löscht alle bin und obj Ordner dotnet clean

(zurück nach oben)

🧪 Testing & Qualitätssicherung

Umfassende Testabdeckung ist essenziell für dieses Template.

Unit & Integration Tests

make test

E2E Tests (Playwright) Um die End-to-End Tests auszuführen:

cd tests/HighPerformanceTemplate.E2ETests
dotnet test

Code-Style Die Einhaltung des Code-Styles wird durch die .editorconfig strikt erzwungen und von modernen IDEs (VS Code, Rider, Visual Studio) automatisch erkannt.

(zurück nach oben)

🔄 CI/CD & DevOps

Das Projekt beinhaltet vorkonfigurierte Workflows:

  • GitHub Actions: Automatisiertes Bauen und Testen bei jedem Push auf main oder develop.
  • Dependabot: Hält NuGet-Pakete und GitHub-Actions automatisch aktuell.
  • GitHub Projects: Kann für Kanban-Board genutzt werden (Repository-Einstellung).

(zurück nach oben)

🤝 Mitwirken

Beiträge sind willkommen! Bitte erstelle einen Fork und sende einen Pull Request.

(zurück nach oben)

📄 Lizenz

Veröffentlicht unter der MIT Lizenz. Siehe LICENSE für weitere Informationen.

(zurück nach oben)