Lokale Installation

Windows

Lokal

Vorteil: schnell und einfach, besonders für die Offline-Nutzung ohne API-Anbindung geeignet.

Nachteil: API-Anbindung ist schmerzhaft - besser auf WSL ausweichen.

WSL

Windows Subsystem for Linux (WSL)

Vorteil: Bessere Linux-Kompatibilität, besonders für die API-Anbindung geeignet.

Nachteil: Etwas komplexer bis die Voraussetzungen installiert sind, danach für jedes weitere Projekt einfach einzurichten.

Lokal

1. NodeJS installieren: 👉 NodeJS herunterladen und installieren.
2. Ausführung von Skripts bei PowerShell zulassen:
   • Überprüfen, ob die Ausführung von Skripts erlaubt ist:

     Get-ExecutionPolicy   # Restricted | RemoteSigned | Unrestricted

   • Falls die Ausgabe Restricted ist, Skriptausführung erlauben:
     1. PowerShell als Administrator öffnen
     2. Befehl ausführen:

        Set-ExecutionPolicy RemoteSigned

3. Yarn installieren:

   npm install --global yarn

4. Repository klonen - das Repository von Github klonen und in VS Code öffnen.
5. Abhängigkeiten installieren: In VS Code Terminal > Neues Terminal öffnen und folgenden Befehl ausführen:

   yarn install

6. .env hinzufügen
   .env

   OFFLINE_API="indexedDB"

   Hinweis

   Die .env-Datei ist notwendig, um die API-Anbindung zu deaktivieren. Sie sollte nie in einem öffentlichen Repository hochgeladen werden, da sie sensible Informationen enthalten kann.

7. Entwicklungsserver starten: Im Terminal folgenden Befehl ausführen:

   yarn run start

WSL

🚧 WIP

TODO

macOS

🚧 WIP

TODO