Ignite Documentation Guide

Diese README fasst die wichtigsten Bereiche der projektspezifischen Dokumentation zusammen und hilft beim Einstieg in APIs, Control Panel und Checkout-Flow. Alle Detaildokumente liegen im Ordner docs/ sowie unter docs/admin/.

---

Inhaltsverzeichnis

1. Architekturüberblick
2. Checkout & Warenkorb
3. Control Panel (/cp)
4. Landing Pages
5. Öffentliche APIs
6. Admin-APIs
7. Seed & Initialdaten
8. Nützliche Komponenten & Hooks

---

Architekturüberblick

• Backend: Next.js API Routes (app/api/**) mit Prisma ORM, Auth über Middleware (withAuth, withAdmin, useCSRF).
• Frontend: Next.js App Router (app/**), modulare Komponenten unter app/components/**, Hooks unter app/cp/hooks/**.
• Docs:
  • Allgemein: docs/*.md
  • Admin-spezifisch: docs/admin/api-admin-*.md
  • Landing Pages: docs/checkout.md, docs/rootserver.md, docs/dedicated.md
  • Control Panel: docs/cp.md

Tipp: Neue APIs immer mit passender Dokumentation ergänzen; bestehende Dateien als Vorlage nutzen.

---

Checkout & Warenkorb

• Dokument: docs/checkout.md
• Route: /checkout
• Kern-APIs:
  • /api/cart/v2
  • /api/payments/balance/create
  • /api/payments/mollie/create
• Features:
  • Mehrstufiger Flow (login → review → billing → payment → confirmation)
  • useCSRF() schützt POST-Requests
  • Balance- vs. Mollie-Zahlungen, automatische Auswahl basierend auf Guthaben

---

Control Panel (/cp)

• Dokument: docs/cp.md
• Struktur:
  • Kundenbereiche: Account, Services, Invoices, Support, Versicherung
  • Adminbereiche: Users, Services, Orders, Pricing, Proxmox, Verification, Inspections
• UI-Komponenten:
  • CPLayout, CPNavbar, Sidebar
  • Diverse Modals für Produkt-/Serviceverwaltung
• Hooks: useApiData, usePageData für standardisierte Datenabfragen

---

Landing Pages

Pfad	Dokumentation	Komponenten
/rootserver	docs/rootserver.md	Navbar, Header, VPSCalculator, Footer
/dedicated	docs/dedicated.md	Navbar, Header, Calculator, Footer

• Beide Seiten nutzen Konfiguratoren zur Kontaktaufnahme mit Pricing-APIs (/api/pricing/**) und zur Übergabe an den Checkout.

---

Öffentliche APIs

Auszug häufig genutzter Dokumente:

• docs/api-products.md – Produktdaten & Kalkulatoroptionen
• docs/api-pricing.md – Preisberechnung für VPS/Dedicated
• docs/api-cart.md – Warenkorblogik (Hinzufügen, Aktualisieren, Discount)
• docs/api-payments.md – Mollie, Balance, Webhooks
• docs/api-account.md, docs/api-addresses.md, docs/api-auth.md – User-Management
• docs/api-services.md, docs/api-tickets.md, docs/api-support.md – Services & Support

Jede Datei beschreibt Endpunkte, Request-/Response-Beispiele, Sicherheit und Frontend-Anbindung.

---

Admin-APIs

Die Admin-Dokumentation liegt unter docs/admin/. Relevante Beispiele:

• api-admin-orders.md, api-admin-services.md, api-admin-users.md
• api-admin-invoices.md, api-admin-price-adjustments.md, api-admin-pricing.md
• api-admin-proxmox.md, api-admin-ipv4.md, api-admin-ovh.md
• api-admin-verification.md, api-admin-insurance-claims.md, api-admin-deletion-requests.md
• api-admin-settings.md, api-admin-statistics.md, api-admin-support.md, api-admin-tickets.md

Jede Datei dokumentiert:

1. Endpunktübersicht
2. Request-/Response-Strukturen
3. Validierungen & Sicherheitschecks
4. Hinweise für Frontend/Workflow

Hinweis: Admin-APIs verwenden konsequent withAdmin (bzw. withAuth mit Rollenprüfung). Einige Routen generieren Debug-Informationen (z. B. OVH, Proxmox), die nur intern genutzt werden sollten.

---

Seed & Initialdaten

• Dokument: docs/admin/api-admin-seed.md
• Endpoint: POST /api/admin/seed
• Funktion:
  • Seedet Standard-Settings, Admin- und Demo-User, Beispielprodukte (VPS & Dedicated).
  • Deaktiviert in produktiven Umgebungen (nur lokale/file-basierte DB).
  • Schließt Prisma-Connection nach Ausführung.

---

Nützliche Komponenten & Hooks

• Komponenten (app/cp/components/**):
  • SystemAlerts, AccountBar, ServicePermissions, TableList
  • Modals für Produkt-/Service-/Invoice-/IP-Verwaltung
• UI-Bibliothek: app/cp/components/ui (Button, Card, DataTable, Modal, StatCard)
• Hooks:
  • useCSRF – CSRF-geschützte Fetches
  • useApiData – generische API-Abfrage mit Loading/Error
  • usePageData – Server-seitige Prefetch-Unterstützung

---

Weiteres Vorgehen

• Neue Features: Relevante Dokumentation ergänzen (API + UI).
• Tests: Edge Cases (Balance-Zahlung, fehlende Adressen, abgelaufene Discounts) prüfen.
• Deployment: Sicherstellen, dass Admin-Endpunkte in Produktion abgesichert bleiben (keine public exposure von Debug-Infos).

Bei Fragen oder Änderungen im Code unbedingt die entsprechenden Dokumente aktualisieren – diese README dient als Einstiegspunkt und verweist auf alle Detailunterlagen.