pxtra Benefit Platform – Entwickler-Dokumentation

Willkommen in der technischen Dokumentation der pxtra Benefit Platform – einer Lösung zur Verwaltung von Mitarbeiter-Benefits für Unternehmen und deren Mitarbeitende.

Hauptkomponenten

Komponente	Technologie	Beschreibung
Backend	Django 5, Python	REST API, Geschäftslogik, Datenverwaltung
Dashboard	React, TypeScript, Vite	Unternehmens-Verwaltungsoberfläche
Mobile App	Svelte, Capacitor	Mitarbeiter-App (Web, iOS, Android)
Client Library	TypeScript	Gemeinsamer API-Client für Dashboard und App

Schnelleinstieg

• Systemübersicht – Architektur und Komponenten auf einen Blick
• Backend einrichten – Lokale Entwicklungsumgebung aufsetzen
• Dashboard einrichten – Dashboard lokal starten
• App einrichten – Mobile App lokal starten

Repository-Struktur

pxtra-benefit-platform/
├── backend/      # Django-Backend
├── dashboard/    # React-Dashboard
├── app/          # Svelte Mobile App
├── client-lib/   # Gemeinsame TypeScript-Bibliothek
├── docker/       # Docker-Konfigurationen
├── e2e/          # Playwright End-to-End-Tests
├── docs/         # Diese Dokumentation (mkdocs.yml + Markdown-Dateien in src/)
└── scripts/      # Build- und Deployment-Skripte

Dokumentation lokal starten

cd docs && mkdocs serve