This commit is contained in:
Kevin Adametz 2025-04-01 11:04:22 +02:00
parent a9a7a6ef4c
commit d010e18178

View file

@ -1 +1,88 @@
# thatsme
# Thats me
Eine kurze Beschreibung, was dieses Projekt macht (ein oder zwei Sätze).
## Inhaltsverzeichnis
- [Beschreibung](#beschreibung)
- [Technologie-Stack](#technologie-stack)
- [Installation](#installation)
- [Verwendung](#verwendung)
- [Mitwirken](#mitwirken)
- [Lizenz](#lizenz)
## 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](https://quasar.dev/) (v2 mit Vite)
- Für Details siehe: [frontend/README.md](./frontend/README.md)
- **Backend:**
- [Laravel](https://laravel.com/) (v12)
- [Livewire](https://livewire.laravel.com/)
- [Volt](https://livewire.laravel.com/docs/volt)
- [Vite](https://vitejs.dev/) (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:**
1. Klone das Repository:
```bash
git clone https://github.com/dein-benutzername/dein-projekt.git
cd dein-projekt
```
2. Installiere die Frontend-Abhängigkeiten (siehe [frontend/README.md](./frontend/README.md) für Details):
```bash
cd frontend
npm install # oder yarn install
cd ..
```
3. Installiere die Backend-Abhängigkeiten (füge hier die entsprechenden Befehle für Laravel hinzu, z.B. `composer install`, `.env` einrichten, Datenbankmigrationen):
```bash
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:**
1. Starte den Backend-Server (im Backend-Verzeichnis):
```bash
php artisan serve #oder laravel herd (https://herd.laravel.com) #oder alternative PHP / MYSQL Serverumgebung (MAMP etc.)
```
2. Starte den Frontend-Entwicklungsserver (im Frontend-Verzeichnis):
```bash
quasar dev
```
3. Öffne die Anwendung in deinem Browser (normalerweise unter `http://localhost:8080` oder 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?
1. Forke das Repository.
2. Erstelle einen neuen Branch (`git checkout -b feature/neues-feature`).
3. Committe deine Änderungen (`git commit -am 'Füge neues Feature hinzu'`).
4. Pushe zum Branch (`git push origin feature/neues-feature`).
5. Ö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](LICENSE.md)-Datei für Details (falls vorhanden).