Web-Entwicklungsumgebung einrichten

Die folgende Sektion beschreibt den leichtgewichtigen Einrichtungsprozess für die Web-App, der eine schnellere Entwicklung und Tests ermöglicht. Für native Funktionen und nicht webbezogene Fehlerbehebungen, siehe den vollständigen Einrichtungsleitfaden, der die Einrichtung der mobilen App-Umgebung beinhaltet.

Voraussetzungen

Forke das Repository und klone es auf deinen lokalen Rechner.
Installiere die erforderliche Software:
- Visual Studio Code
- Docker Desktop (optional, für CORS-Proxy)
Installiere die benötigten Abhängigkeiten:
- Node.js 22 LTS oder höher
- Bun oder nutze npm, wenn du die Abhängigkeiten nicht änderst
Es wird empfohlen, die Biome Erweiterung für deine IDE zu verwenden, um Echtzeit-Feedback zu deinem Code zu erhalten.
Installiere die Projektabhängigkeiten, indem du den folgenden Befehl im Projektverzeichnis ausführst:
```
bun install
```
Kopiere die .env.local.example Datei in .env.local und fülle die Variablen aus.
Siehe die Hinweise zum API-Schlüssel.

.env.local


EXPO_PUBLIC_THI_API_KEY=abc123

Entwicklung

Erstelle einen neuen Branch von deinem Fork, um zum Projekt beizutragen. Verwende einen beschreibenden Branch-Namen.
Mache deine Änderungen und stelle sicher, dass der Code unserem Coding-Stil und den Konventionen folgt.
Starte die App lokal mit Expo, indem du folgenden Befehl im Projektverzeichnis ausführst:
```
bun web
```

Detailierte Informationen zum Beitragen am Projekt und zum Code-Stil findest du im vollständigen Einrichtungsleitfaden.

Aufgrund der CORS Regeln der THI API, welche localhost nicht erlauben, musst du einen Proxy oder eine Browser-Erweiterung verwenden, um die API im Browser zu verwenden.

CORS-Proxy einrichten

Um die THI API während der lokalen Entwicklung nutzen zu können, wird empfohlen, den Neuland CORS Proxy zu verwenden.

Der Proxy ist nur für die lokale Entwicklung gedacht und sollte nicht in Produktionsumgebungen verwendet werden!

Mit Docker (Empfohlen)

Die einfachste Methode ist die Verwendung von Docker:


docker run -p 3001:3001 ghcr.io/neuland-ingolstadt/neuland-next-proxy:latest

Der Proxy läuft nun auf http://localhost:3001.

Optional: Verwende einen anderen Port:


docker run -p 8080:8080 -e PORT=8080 ghcr.io/neuland-ingolstadt/neuland-next-proxy:latest

Manuelle Installation

Alternativ kannst du den Proxy auch manuell installieren:

Klone das Proxy-Repository:


git clone https://github.com/neuland-ingolstadt/neuland-next-proxy.git
cd neuland-next-proxy

Installiere die Abhängigkeiten:
```
pnpm install
```
Starte den Proxy-Server:
```
pnpm dev
```

Neuland Next Web konfigurieren

Füge die folgende Umgebungsvariable zu deiner .env.local Datei hinzu:

.env.local


EXPO_PUBLIC_ENDPOINT_HOST=http://localhost:3001

Jetzt kannst du die Web-App mit bun web starten und die THI API wird über den Proxy aufgerufen.