From 26d430202e16783686b5ab62d1e04dda6fab319e Mon Sep 17 00:00:00 2001 From: Sebastian Frank Date: Wed, 15 Nov 2023 09:01:34 +0100 Subject: [PATCH] =?UTF-8?q?Coding=20Guideline=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Coding-Guideline.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 Coding-Guideline.md diff --git a/Coding-Guideline.md b/Coding-Guideline.md new file mode 100644 index 0000000..52e2cf9 --- /dev/null +++ b/Coding-Guideline.md @@ -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 \ No newline at end of file