first docs
This commit is contained in:
21
README.md
21
README.md
@@ -0,0 +1,21 @@
|
||||
# TibiCMS Dokumentation
|
||||
|
||||
Quickstart Anleitung zum TibiCMS (tibi-server und tibi-admin)
|
||||
|
||||
## Einleitung
|
||||
|
||||
TibiCMS ist der Sammelbegriff für die Komponenten "tibi-server" und "tibi-admin", welche einen REST-API Server und eine Administrationsoberfläche zur Verfügung stellen. Auf Basis dieser beiden Komponenten und der MongoDB als Abhängigkeit lassen sich WebCMS Anwendungen abbilden.
|
||||
|
||||
Das CMS ist multi-mandanten-fähig, d.h. es kann mehrer Projekte mit unterschiedlichen Zugriffsbeschränkungen verwalten.
|
||||
|
||||
### tibi-server
|
||||
|
||||
Der Server selbst kommt ohne grafische Oberfläche oder WebUI. Er ist ausschließlich nach außen über eine REST-API erreichbar.
|
||||
|
||||
Als einzige Abhängigkeit ist eine "MongoDB" zu erwähnen. Da der Server in Go geschrieben ist, sind keine externen Bibliotheken notwendig. Er lässt sich daher prima via Docker-Container verteilen.
|
||||
|
||||
### tibi-admin
|
||||
|
||||
Die Administrationsoberfläche ist wie jeder andere Service, der die REST-API des Servers nutzt, nur ein Frontend. tibi-admin läuft vollständig im Browser und benötigt nur einen Webserver, der statischen Content ausliefert.
|
||||
|
||||
Die Version der Admin-UI sollte synchron zur tibi-server Version gehalten werden, damit alle Datentypen bedient werden können.
|
||||
Reference in New Issue
Block a user