Dokumentation

FairOrder ist Open Source

Quellcode einsehbar, selbst hostbar, erweiterbar. Lizenziert unter AGPL-3.0.

Diese Dokumentation richtet sich an Entwickler, Systemadministratoren und alle, die FairOrder auf eigener Infrastruktur betreiben oder zum Projekt beitragen wollen.

Self-Hosting

Anleitung

FairOrder auf deinem eigenen Server betreiben. Schritt-für-Schritt-Anleitung mit Docker, PostgreSQL und Reverse Proxy.

API-Referenz

Referenz

Alle REST-Endpunkte dokumentiert. Authentifizierung, Locations, Kategorien, Speisekarte, Bestellungen.

Beitragen

Community

Wie du zum Projekt beitragen kannst. Development-Setup, Code-Style, Pull-Request-Prozess.

Source Code

GitHub

Der vollständige Quellcode auf GitHub. Issues, Discussions und Releases.

Schnellstart

FairOrder lokal starten:

git clone https://github.com/RayNCooper/fairorder.git
cd fairorder
cp .env.example .env    # DATABASE_URL anpassen
pnpm install
pnpm db:generate
pnpm db:push
pnpm dev:local

Voraussetzungen: Node.js 20+, pnpm, PostgreSQL 14+