gateway/docs/real-estate-feature-integration-guide/README.md

1.7 KiB

Feature Integration Guide: realEstate

Diese Dokumentation erklärt Schritt für Schritt, wie Sie ein neues Feature "realEstate" in das Gateway-Projekt integrieren. Das Feature ermöglicht es, über ein Chat-Interface Datenbankabfragen auf Real Estate-Daten (Architektur-Planungs-App) durchzuführen.

Referenz: Das zugrundeliegende Datenmodell ist in ../PEK_datamodel_desc.md beschrieben (PEK ist ein Beispiel für eine Real Estate-Firma, das Modell ist aber allgemein verwendbar).

Inhaltsverzeichnis

  1. Überblick und Projektstruktur
  2. Schritt 1: Datenmodell erstellen
  3. Schritt 2: Interface erstellen
  4. Schritt 3: Feature-Logik implementieren
  5. Schritt 4: Routen erstellen
  6. Schritt 5: Router registrieren
  7. Schritt 6: Environment-Konfiguration
  8. Schritt 7: Feature Lifecycle (optional)
  9. Datenbank-Schema und Tabellenerstellung
  10. Sicherheitshinweise
  11. Testing
  12. Troubleshooting
  13. Zusammenfassung

Schnellstart

Für eine schnelle Übersicht über alle zu erstellenden Dateien, siehe Zusammenfassung.

Architektur-Überblick

Die Architektur folgt dem Muster bestehender Features wie chatPlayground:

  • Routes (modules/routes/) - API-Endpunkte
  • Features (modules/features/) - Geschäftslogik
  • Interfaces (modules/interfaces/) - Datenbankzugriff
  • DataModels (modules/datamodels/) - Pydantic-Modelle

Nächster Schritt: 01-overview.md