cms/tibi-docs
Template
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Coding Guideline hinzugefügt

Sebastian Frank 2023-11-15 09:01:34 +01:00
commit 26d430202e
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Coding-Guideline.md Normal file

@ -0,0 +1,20 @@
# Coding Guideline zur Erstellung von Tibi-Projekten
## Ausgangspunkt
1. der Designentwurf für das Frontend liegt vor
2. die benötigten Datenstrukturen sind klar
- evtl. dazu innerhalb der Konzeptphase gemeinsam Datenstruktur erarbeiten
## Aufbau des Backends (tibi-admin)
### Ableiten der Kollektionen
- anhand der benötigten Datenstrukturen Kollektionen formen
- ohne direkt in Tibi-Konfigs zu starten am besten die Kollektionen mit anderen Tools visualisieren und Abhängigkeiten erkennen un einzeichnen (Entity Relation)
- beim Entwickeln der Kollektionen unterschiedliche Berechtigungen berücksichtigen
- z.B. Kollektion für Einstellungen von Modulen müssen normale Redakteure nicht bearbeiten, echte Inhalte dagegen schon
- Anzahl der Kollektionen gering halten, da
- viele Verknüpfungen mehrere Anfragen im tibi-server benötigen (Performance)
- Datensätze verteilt auf mehrere Kollektionen dem Benutzer mehr Klicks abverlangen (Usability)
- mongoDB im Gegensatz zu relationalen Datenbanken sehr gut mit eingebetten Daten innerhalb von Objekt-Strukturen zurecht kommt