thats-me/backend/README.md
2025-04-01 10:49:26 +02:00

3.4 KiB

Thats me Backend

Dies ist das Backend für die "Thats me"-Anwendung, basierend auf dem Laravel Framework.

Technologie-Stack

Installation

  1. Repository klonen (falls noch nicht im Hauptprojekt geschehen):

    git clone <repository-url>
    cd <projekt-ordner>/backend # Oder der entsprechende Pfad zum Backend
    
  2. PHP Abhängigkeiten installieren:

    composer install
    
  3. Konfigurationsdatei erstellen: Kopiere die Beispiel-Umgebungsvariablendatei:

    cp .env.example .env
    

    _Hinweis: Bearbeite die .env-Datei und konfiguriere insbesondere die Datenbankverbindung (DB\__) und die APP_URL.*

  4. Anwendungsschlüssel generieren:

    php artisan key:generate
    
  5. Datenbankmigrationen ausführen: Stelle sicher, dass deine Datenbank konfiguriert ist (siehe Schritt 3).

    php artisan migrate
    

    Optional: Wenn du Seed-Daten hast:

    php artisan db:seed # Optional
    
  6. Frontend Assets installieren und bauen:

    npm install # oder yarn install
    npm run build # Baut die Assets für die Produktion
    

Entwicklung

Entwicklungsserver starten:

Um den lokalen Laravel-Entwicklungsserver zu starten (normalerweise auf http://127.0.0.1:8000):

php artisan serve
#oder laravel herd (https://herd.laravel.com) #oder alternative PHP / MYSQL Serverumgebung (MAMP etc.)

Frontend Assets mit Vite:

Um den Vite-Server für Hot Module Replacement (HMR) während der Frontend-Entwicklung (innerhalb von Laravel/Blade/Livewire) zu starten:

npm run dev # oder yarn dev

Die Konfiguration für Vite (wie z.B. die Eingabedateien für CSS/JS und die Verwendung des Laravel-Plugins) wird in der Datei vite.config.js im Stammverzeichnis des Backends festgelegt. Diese Datei ist entscheidend dafür, wie Vite die Assets für die Laravel-Anwendung verarbeitet und bündelt.

Hinweis: Der Vite-Server läuft normalerweise auf einem anderen Port (z.B. 5173) und arbeitet mit php artisan serve zusammen.

Testing

Um die PHPUnit-Tests auszuführen:

php artisan test

Livewire & Volt

Dieses Projekt nutzt Livewire und Volt für interaktive Frontend-Komponenten direkt im Backend-Code. Komponenten findest du typischerweise in:

  • Livewire: app/Livewire/ oder app/Http/Livewire/ (je nach Konfiguration)
  • Volt: Oft als Single-File-Komponenten direkt in den resources/views/livewire/ oder resources/views/components/ Verzeichnissen (als .blade.php Dateien mit <script> und <style> Sektionen).

Weitere Informationen findest du in der Livewire Dokumentation und der Volt Dokumentation.

Mitwirken

[Hier Richtlinien für Beiträge hinzufügen, falls gewünscht. Ähnlich wie im Haupt-README.]

Lizenz