No description
| .github | ||
| .vscode | ||
| backend | ||
| documentation | ||
| frontend | ||
| test | ||
| .gitignore | ||
| README.md | ||
| thats-me.test.code-workspace | ||
Thats me
Eine kurze Beschreibung, was dieses Projekt macht (ein oder zwei Sätze).
Inhaltsverzeichnis
Start
- cd frontend
- npm install
- npm run dev
- npm run build
Beschreibung
Eine ausführlichere Beschreibung des Projekts. Was ist das Ziel? Welche Probleme löst es? Was sind die Hauptmerkmale?
Technologie-Stack
Dieses Projekt verwendet die folgenden Technologien:
- Frontend:
- Quasar Framework (v2 mit Vite)
- Für Details siehe: frontend/README.md
- Backend:
- Laravel (v12)
- Livewire
- Volt
- Vite (für Asset-Bundling im Backend)
- [Flux] (https://fluxui.dev) (Componten für das Backend)
- (Optional: Füge hier einen Link zum Backend-README hinzu, falls vorhanden, z.B.
[backend/README.md](./backend/README.md))
Installation
Beispiel:
- Klone das Repository:
git clone https://github.com/dein-benutzername/dein-projekt.git cd dein-projekt - Installiere die Frontend-Abhängigkeiten (siehe frontend/README.md für Details):
cd frontend npm install # oder yarn install cd .. - Installiere die Backend-Abhängigkeiten (füge hier die entsprechenden Befehle für Laravel hinzu, z.B.
composer install,.enveinrichten, Datenbankmigrationen):cd backend # (oder das Stammverzeichnis, je nach Struktur) composer install cp .env.example .env php artisan key:generate # ... weitere Backend-Setup-Schritte ... cd ..
Verwendung
Wie wird das Projekt gestartet und verwendet? Beschreibe, wie man sowohl den Frontend- als auch den Backend-Server startet.
Beispiel:
- Starte den Backend-Server (im Backend-Verzeichnis):
php artisan serve #oder laravel herd (https://herd.laravel.com) #oder alternative PHP / MYSQL Serverumgebung (MAMP etc.) - Starte den Frontend-Entwicklungsserver (im Frontend-Verzeichnis):
quasar dev - Öffne die Anwendung in deinem Browser (normalerweise unter
http://localhost:8080oder einer ähnlichen Adresse, die vom Quasar Dev-Server angezeigt wird).
Mitwirken
Erkläre, wie andere zum Projekt beitragen können. Gibt es Richtlinien für Pull Requests oder das Melden von Fehlern?
- Forke das Repository.
- Erstelle einen neuen Branch (
git checkout -b feature/neues-feature). - Committe deine Änderungen (
git commit -am 'Füge neues Feature hinzu'). - Pushe zum Branch (
git push origin feature/neues-feature). - Öffne einen Pull Request.
Lizenz
Gib an, unter welcher Lizenz das Projekt veröffentlicht wird. Zum Beispiel:
Dieses Projekt ist unter der MIT-Lizenz lizenziert - siehe die LICENSE.md-Datei für Details (falls vorhanden).