Skip to main content

Getting Started

Lass uns das Projekt schnell und einfach zum Laufen bringen.

Voraussetzungen​

Bevor du beginnst, stelle sicher, dass dein System die folgenden Anforderungen erfüllt.

Systemanforderungen​

  • RAM: Mindestens 2 GB
  • CPU: Mindestens 2 Kerne

Benötigte Software​

  • Git – zum Klonen des Repositories
  • Docker & Docker Compose – zum Starten der Anwendung
  • Docker installieren
  • Docker Compose ist ab Docker Desktop bereits enthalten

Schritt 1: Repository klonen​

Klone das Projekt von GitHub auf deinen lokalen Rechner:

git clone https://gitlab.com/rene.herrmann/uni-verein.git

Wechsle anschließend in das Projektverzeichnis:

cd uni-verein

Schritt 2: Docker installieren​

Falls Docker noch nicht installiert ist, lade es von der offiziellen Seite herunter und installiere es:

👉 https://docs.docker.com/get-docker/

Überprüfe nach der Installation, ob Docker korrekt funktioniert:

docker --version
docker compose version

Schritt 3: .env Datei erstellen​

Die Anwendung benötigt eine .env Datei mit Umgebungsvariablen.

Erstelle die Datei im Wurzelverzeichnis des Projekts (uni-verein/.env):

cp .env.example .env

Falls keine .env.example vorhanden ist, erstelle die Datei manuell:

touch .env

Öffne die Datei und befülle die notwendigen Werte:

nano .env

Schritt 4: Sicherheitsschlüssel generieren​

JWT_KEY benötigt einen geheime Schlüssel (Secret Keys im HEX format). Diese kannst du wie folgt generieren:

Mit OpenSSL (empfohlen)​

openssl rand -hex 32

HMAC_KEY und CRYPTO_KEY benötigen jeweils geheime Schlüssel (Secret Keys im base64 format). Diese kannst du wie folgt generieren:

Mit C# (empfohlen):​

var key = new byte[32];
RandomNumberGenerator.Fill(key);
Console.WriteLine(Convert.ToBase64String(key));

Füge die generierten Schlüssel in deine .env Datei ein, zum Beispiel:

JWT_KEY=dein-generierter-schlüssel
JWT_ISSUER=uni-verein
HMAC_KEY=ein-weiterer-schlüssel
CRYPTO_KEY=ein-weiterer-schlüssel

⚠️ Wichtig: Teile deine .env Datei niemals öffentlich und füge sie nicht in Git ein. Stelle sicher, dass .env in der .gitignore eingetragen ist.

Schritt 5: Projekt starten​

Starte die Anwendung mit Docker Compose:

docker compose -f docker-compose.yml up --build -d

Die Anwendung ist anschließend unter http://localhost:80 erreichbar.

Um die laufenden Container zu überprüfen:

docker compose ps

Um die Logs einzusehen:

docker compose logs -f