diff --git a/README.md b/README.md index 7046a1830d571ecaa95e455b2509044bd2e5db69..b27944e7cb06c4306cf505b6fc45175d5de3a84a 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ -# SAMSHub - -Die SAMSHub Klasse ermöglicht es einen Modularen Anwendungsserver zu schreiben. -Die Klasse sätzt für Module ein einheitlich definiertes Format voraus und erlaubt -das dynamische einladen von Modulen auf basis einer Konfigurationsdatei. - -## Projektlayout - -Das Layout eines SAMSHub Projektes sieht im Wesendlichen wie folgt aus- - -- Project_Dir/ - - \_\_init\_\_.py - - views.py - - modules/ - - hallo_modul/ - - \_\_init\_\_.py - - manifest.yaml - - languages/ - - templates/ - - hallo_modul/ - - hallo_modul.html - - sub_view.html - - static/ - - templates/ - - static/ +# sams_classes + +Dieses Python3 Modul stellt die Grundlage für die Implementierung von +Applicationservern in der Selve-/ Administravie-Microservice-Structure dar. +Das Künftige MIPortal, ZID und andere Anwendungen sollen diese Klassen verwenden +verwenden können. + +## Klassen + +Derzeit enthält die Bibliothek drei Klassen + +- SAMSHub +- SAMApp +- SAMSProxy + +### SAMSHub + +SAMSHub stellt eine gewöhnliche flask App bereit, die alle grundsätzlich +für die Konkreten Server immer benötigten Eigenschaften mitbringt. +die Flask App besitzt bereits einen context_processor um Sprach-Dictionaries +der Apps und Menüeinträge den jeweiligen Termplates verfügbar zu machen. +Der SAMSHub folgt dem Designprinzip 'Komposition über Vererbung'. Dadurch lassen +sich das gesamte Wissen über Flask und alle möglichkeiten von Flask auch auf die +vom SAMSHub bereitgestellte flaskApp anwenden. Der SAMSHub erledigt lediglich +einige Aufgaben die so bei allen Zukünftigen Anwendungen anfallen werden. + +### SAMSApp + +**TODO** + +### SAMSProxy + +**TODO** \ No newline at end of file