oqtane-general-description #62
@@ -6,6 +6,28 @@ gitea: none
|
||||
# Technologie
|
||||
## Entwicklung mit Asp.Net (Was ist Blazor? / Was ist Razor? / Kestrel)
|
||||
|
Kocoder marked this conversation as resolved
Outdated
|
||||
## Was ist Oqtane? Architektur von Oqtane?
|
||||
Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.Net und Blazor. [^5] Ein Oqtane System besteht aus mehreren Komponenten.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Zusammengesetzte Substantive werden im Deutschen mit Bindestrich oder zusammengeschrieben. Zusammengesetzte Substantive werden im Deutschen mit Bindestrich oder zusammengeschrieben.
```suggestion
Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.NET und Blazor. [^5] Ein Oqtane-System besteht aus mehreren Komponenten.
```
|
||||
|
||||
In dieser Diplomarbeit fokussieren wir uns hauptsächlich auf `Themes` und `Modules`, aber es gibt auch `Language Packs` und `Pure Extensions`. [^6]
|
||||
|
gitea-actions
commented
Fachbegriffe im Deutschen werden oft zusammengeschrieben oder mit Bindestrich versehen (Durchkopplung). Fachbegriffe im Deutschen werden oft zusammengeschrieben oder mit Bindestrich versehen (Durchkopplung).
```suggestion
In dieser Diplomarbeit fokussieren wir uns hauptsächlich auf `Themes` und `Modules`, aber es gibt auch `Language-Packs` und `Pure-Extensions`. [^6]
```
|
||||
|
||||
Ein Modul soll neue Funktoinalitäten in das CMS hinzufügen und ein Theme soll die ganze Gestaltung der Website (die Shell) festlegen. [^6]
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Rechtschreibfehler: 'Funktoinalitäten' -> 'Funktionalitäten'. Rechtschreibfehler: 'Funktoinalitäten' -> 'Funktionalitäten'.
```suggestion
Ein Modul soll neue Funktionalitäten in das CMS hinzufügen und ein Theme soll die ganze Gestaltung der Website (die Shell) festlegen. [^6]
```
gitea-actions
commented
Grammatik: 'in das CMS hinzufügen' ist unüblich. Besser: 'dem CMS hinzufügen'. 'Ganze' durch 'gesamte' ersetzt für einen professionelleren Stil. Grammatik: 'in das CMS hinzufügen' ist unüblich. Besser: 'dem CMS hinzufügen'. 'Ganze' durch 'gesamte' ersetzt für einen professionelleren Stil.
```suggestion
Ein `Module` (Modul) soll dem CMS neue Funktionalitäten hinzufügen und ein `Theme` soll die gesamte Gestaltung der Website (die Shell) festlegen. [^6]
```
|
||||
|
||||
[^5]: https://www.oqtane.org/#about
|
||||
[^6]: https://docs.oqtane.org/dev/extensions/index.html
|
||||
|
||||
### Architektur eines Moduls
|
||||
Ein Modul in Oqtane besteht aus 4 Projekten. Server, Client, Shared und Package.
|
||||
|
gitea-actions
commented
Stil: Der Satz besteht aus Fragmenten. Ein Doppelpunkt ist hier passender. Stil: Der Satz besteht aus Fragmenten. Ein Doppelpunkt ist hier passender.
```suggestion
Ein Modul in Oqtane besteht aus vier Projekten: Server, Client, Shared und Package.
```
|
||||
|
||||
Im Server Projekt liegt Source Code, welcher Serverseitig ausgeführt werden soll. In der Praxis bedeutet das: alle Repositories, Controller, Manager, Migratoinen und Server-Services (entwickelt nach einem Interface definiert im Client) und Server-Startup logik.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Mehrere Korrekturen: 'Sourcecode' (Zusammenschreibung), 'serverseitig' (Kleinschreibung als Adjektiv/Adverb), 'Migrationen' (Tippfehler) und 'Startup-Logik' (Bindestrich). Mehrere Korrekturen: 'Sourcecode' (Zusammenschreibung), 'serverseitig' (Kleinschreibung als Adjektiv/Adverb), 'Migrationen' (Tippfehler) und 'Startup-Logik' (Bindestrich).
```suggestion
Im Server-Projekt liegt Sourcecode, welcher serverseitig ausgeführt werden soll. In der Praxis bedeutet das: alle Repositories, Controller, Manager, Migrationen und Server-Services (entwickelt nach einem Interface definiert im Client) und Server-Startup-Logik.
```
gitea-actions
commented
Rechtschreibung: 'Startup-Logik' wird im Deutschen mit Bindestrich oder zusammengeschrieben. 'welcher' kann durch das flüssigere 'der' ersetzt werden. Rechtschreibung: 'Startup-Logik' wird im Deutschen mit Bindestrich oder zusammengeschrieben. 'welcher' kann durch das flüssigere 'der' ersetzt werden.
```suggestion
Im Server-Projekt liegt der Quellcode, der serverseitig ausgeführt werden soll. In der Praxis bedeutet das: alle Repositories, Controller, Manager, Migrationen, Server-Services (entwickelt nach einem im Client definierten Interface) und die Server-Startup-Logik.
```
|
||||
|
||||
Im Client Projekt liegen Code und Razor Komponenten für den Client. Also Client-Staruplogik, Client-Services (+ Inferfaces dafür, die Services hier sollen lediglich die Server-Services über HTTP aufrufen), Ressource-Dateien (.resx), die Komponenten / das User Interface und die Moduldefinitionen für jedes Modul.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Mehrere Korrekturen: Bindestriche bei 'Razor-Komponenten', 'Startup-Logik'. Rechtschreibfehler 'Interfaces' und 'Ressourcendateien'. Mehrere Korrekturen: Bindestriche bei 'Razor-Komponenten', 'Startup-Logik'. Rechtschreibfehler 'Interfaces' und 'Ressourcendateien'.
```suggestion
Im Client-Projekt liegen Code und Razor-Komponenten für den Client. Also Client-Startuplogik, Client-Services (+ Interfaces dafür, die Services hier sollen lediglich die Server-Services über HTTP aufrufen), Ressourcendateien (.resx), die Komponenten / das User Interface und die Moduldefinitionen für jedes Modul.
```
gitea-actions
commented
Tippfehler: 'Staruplogik' -> 'Startup-Logik' und 'Inferfaces' -> 'Interfaces'. 'User Interface' -> 'User-Interface'. Tippfehler: 'Staruplogik' -> 'Startup-Logik' und 'Inferfaces' -> 'Interfaces'. 'User Interface' -> 'User-Interface'.
```suggestion
Im Client-Projekt liegen Code und Razor-Komponenten für den Client. Also Client-Startup-Logik, Client-Services (+ Interfaces dafür; die Services hier sollen lediglich die Server-Services über HTTP aufrufen), Ressourcendateien (.resx), die Komponenten / das User-Interface und die Moduldefinitionen für jedes Modul.
```
|
||||
|
||||
Im Shared Projekt wird geteilter Source-Code abgelegt, der Server und Clientseitig verwendet wird. In der Praxis bleibt's hierbei bei den EntityFramework Modellen zum speichern der Daten im Arbeitsspeicher.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Korrektur: 'server- und clientseitig' (Bindestrich bei Ergänzungen) und 'Speichern' (Substantivierung). Korrektur: 'server- und clientseitig' (Bindestrich bei Ergänzungen) und 'Speichern' (Substantivierung).
```suggestion
Im Shared-Projekt wird geteilter Sourcecode abgelegt, der server- und clientseitig verwendet wird. In der Praxis bleibt's hierbei bei den EntityFramework-Modellen zum Speichern der Daten im Arbeitsspeicher.
```
gitea-actions
commented
Rechtschreibung: 'EntityFramework' -> 'Entity-Framework'. Rechtschreibung: 'EntityFramework' -> 'Entity-Framework'.
```suggestion
Im Shared-Projekt wird geteilter Quellcode abgelegt, der server- und clientseitig verwendet wird. In der Praxis bleibt es hierbei bei den Entity-Framework-Modellen zum Speichern der Daten.
```
|
||||
|
||||
Im Package Projekt findet man Skripte zum debuggen und releasen eines Moduls. Und die Nuget Spezifikation.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Korrektur: 'Debuggen' und 'Releasen' (Substantivierung) sowie 'NuGet-Spezifikation'. Korrektur: 'Debuggen' und 'Releasen' (Substantivierung) sowie 'NuGet-Spezifikation'.
```suggestion
Im Package-Projekt findet man Skripte zum Debuggen und Releasen eines Moduls. Und die NuGet-Spezifikation.
```
gitea-actions
commented
Rechtschreibung: 'Package Projekt' -> 'Package-Projekt' (Kompositum). Rechtschreibung: 'Package Projekt' -> 'Package-Projekt' (Kompositum).
```suggestion
Im Package-Projekt findet man Skripte zum Debuggen und Releasen eines Moduls sowie die NuGet-Spezifikation.
```
|
||||
- Beim Debug werden die dlls, pdbs und statischen Assets wie Skripte und Stylesheets der 3 anderen Projekte in den bereits gebauten Oqtane.Server `oqtane.framework/oqtane.server/bin/debug/net10.0/...` kopiert.
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Dateiendungen/Akronyme wie DLLs und PDBs sollten großgeschrieben werden. Dateiendungen/Akronyme wie DLLs und PDBs sollten großgeschrieben werden.
```suggestion
- Beim Debug werden die DLLs, PDBs und statischen Assets wie Skripte und Stylesheets der 3 anderen Projekte in den bereits gebauten Oqtane.Server `oqtane.framework/oqtane.server/bin/debug/net10.0/...` kopiert.
```
gitea-actions
commented
Grammatik/Stil: 'Beim Debug' -> 'Beim Debuggen'. Pfadangaben sollten in Backticks stehen. Grammatik/Stil: 'Beim Debug' -> 'Beim Debuggen'. Pfadangaben sollten in Backticks stehen.
```suggestion
- Beim Debuggen werden die DLLs, PDBs und statischen Assets wie Skripte und Stylesheets der drei anderen Projekte in den bereits gebauten Oqtane.Server `oqtane.framework/oqtane.server/bin/debug/net10.0/...` kopiert.
```
|
||||
- Beim Release wird ein Nuget Paket erstellt und unter oqtane.framework/oqtane.server/Packages abgelegt. Dort abgelegte Nuget's werden beim nächsten Start des Oqtane Servers installiert (DB Migrationen werden gemacht und nuget's entpackt).
|
||||
|
Kocoder marked this conversation as resolved
Outdated
gitea-actions
commented
Korrektur: 'NuGet-Paket' und Plural 'NuGets' (ohne Apostroph). Korrektur: 'NuGet-Paket' und Plural 'NuGets' (ohne Apostroph).
```suggestion
- Beim Release wird ein NuGet-Paket erstellt und unter oqtane.framework/oqtane.server/Packages abgelegt. Dort abgelegte NuGets werden beim nächsten Start des Oqtane-Servers installiert (DB-Migrationen werden gemacht und NuGets entpackt).
```
gitea-actions
commented
Rechtschreibung: 'DB Migrationen' -> 'DB-Migrationen'. Pfadangabe in Backticks. Rechtschreibung: 'DB Migrationen' -> 'DB-Migrationen'. Pfadangabe in Backticks.
```suggestion
- Beim Release wird ein NuGet-Paket erstellt und unter `oqtane.framework/oqtane.server/Packages` abgelegt. Dort abgelegte NuGet-Pakete werden beim nächsten Start des Oqtane-Servers installiert (DB-Migrationen werden durchgeführt und die Pakete entpackt).
```
|
||||
|
||||
## Systemarchitektur (Postgres / Oqtane / Nginx )
|
||||
```mermaid
|
||||
architecture-beta
|
||||
|
||||
Schreibweise von ASP.NET korrigieren (Großbuchstaben).