Community

Zu FairOrder beitragen

Beiträge sind willkommen. Ob Bugfix, neue Funktion oder Dokumentation — jeder Pull Request wird gelesen und reviewed.

Development-Setup

Das Contributor-Setup nutzt die :local-Scripts, die keine dotenvx-Verschlüsselung benötigen:

# Repository forken und klonen
git clone https://github.com/DEIN-USERNAME/fairorder.git
cd fairorder

# Umgebung einrichten
cp .env.example .env
# DATABASE_URL in .env anpassen

# Abhängigkeiten installieren
pnpm install

# Datenbank einrichten
pnpm db:generate
pnpm db:push
pnpm db:seed          # Optional: Demo-Daten laden

# Dev-Server starten
pnpm dev:local        # Startet auf http://localhost:3000

Tech Stack

BereichTechnologie
FrameworkNext.js 16 (App Router, Turbopack)
SpracheTypeScript (strict mode)
DatenbankPostgreSQL mit Prisma ORM v7
UITailwind CSS v4, Radix UI, shadcn/ui
AuthMagic Link mit httpOnly Session Cookies
TestsVitest
Package Managerpnpm

Code-Style

  • -TypeScript strict mode. Keine any ohne ESLint-Disable-Kommentar.
  • -cn() aus lib/utils.ts für bedingte Klassen.
  • -Deutsche Locale mit informellem "du".
  • -Border-Radius: immer 0px.
  • -Fonts: Plus Jakarta Sans (Headings), JetBrains Mono (Zahlen, Metadata).

Pull-Request-Prozess

  1. -Fork erstellen und Feature-Branch anlegen (feat/mein-feature oder fix/mein-bugfix).
  2. -Änderungen implementieren. Tests schreiben oder aktualisieren.
  3. -pnpm lint und pnpm test laufen lassen.
  4. -Pull Request gegen main öffnen. Beschreibung auf Deutsch oder Englisch.

Commit-Konventionen

Wir verwenden Angular-Style Commit Messages:

feat: neue Funktion hinzufügen
fix: Bug in der Bestelllogik beheben
docs: README aktualisieren
chore: Abhängigkeiten updaten
refactor: Auth-Middleware vereinfachen

Einstiegspunkte

Gute Startpunkte für erste Beiträge:

  • -Issues mit dem Label good first issue auf GitHub
  • -Übersetzungen (z.B. Englisch)
  • -Test-Coverage erweitern
  • -Dokumentation verbessern

Zum Repository | Issues ansehen