Setup und Installation - Sawatec/streakify GitHub Wiki

Setup und Installation

Diese Anleitung beschreibt die Schritte, die erforderlich sind, um die Entwicklungsumgebung für unser Projekt einzurichten und die Anwendung lokal auszuführen.

Inhaltsverzeichnis

Voraussetzungen
Installationsanleitung
Projekt starten
Problemlösung

Voraussetzungen

Bevor ihr mit der Installation beginnt, stellt sicher, dass die folgenden Voraussetzungen erfüllt sind:

Node.js (Version XX oder höher)
Node.js ist für die Ausführung des Servers notwendig. Download Node.js
npm oder yarn
Ein Paketmanager wie npm oder yarn ist erforderlich, um die Abhängigkeiten zu installieren. npm wird mit Node.js geliefert, während yarn separat installiert werden muss. Download Yarn
Git
Git ist erforderlich, um das Projekt-Repository zu klonen. Download Git
MongoDB
MongoDB ist die Datenbank für das Projekt. Entweder lokal installieren oder einen Cloud-Dienst wie MongoDB Atlas verwenden. Download MongoDB

Installationsanleitung

Repository klonen
Klone das Projekt-Repository in dein lokales Verzeichnis: git clone https://gitlab.com/username/project-repo.git
Repository klonen
Navigiere in das Verzeichnis des Projekts: cd project-repo
Abhängigkeiten installieren
Installiere alle erforderlichen Pakete mit npm oder yarn: npm install
Umgebungsvariablen konfigurieren
rstelle eine .env-Datei im Projektverzeichnis und füge die erforderlichen Umgebungsvariablen hinzu, z.B.:\ MONGODB_URI=mongodb://localhost:27017/project-db
PORT=3000
SECRET_KEY=your-secret-key
Datenbank einrichten
Stelle sicher, dass MongoDB läuft und die Datenbank konfiguriert ist. Alternativ kannst du eine Verbindung zu einem Remote-MongoDB-Cluster herstellen.

Projekt starten

Nach der Installation kann das Projekt gestartet werden.

Entwicklungsmodus starten
Starte die Anwendung im Entwicklungsmodus, um Hot-Reloading und Debugging-Features zu nutzen: npm run dev oder yarn dev
Produktionsmodus starten
Um die Anwendung im Produktionsmodus zu starten, benutze den folgenden Befehl: npm start oder yarn start

Nach dem Start sollte die Anwendung unter http://localhost:3000 (oder dem in .env angegebenen Port) erreichbar sein.

Problemlösung

Hier sind einige häufig auftretende Probleme und deren Lösungen:

Fehler: „EADDRINUSE“
Ursache: Der Port ist bereits belegt.oder yarn dev
Lösung: Ändere den Port in der .env-Datei oder schließe die Anwendung, die den Port verwendet.
Datenbankverbindungsfehler
Ursache: MongoDB läuft nicht oder die Verbindungseinstellungen sind falsch.
Lösung: Stelle sicher, dass MongoDB läuft und die richtige URI in der .env-Datei eingestellt ist.
Abhängigkeiten fehlen
Ursache: Einige Pakete wurden nicht installiert.
Lösung: Führe npm install oder yarn install erneut aus, um fehlende Abhängigkeiten zu installieren.

Hinweis: Diese Anleitung wird regelmäßig aktualisiert, um sicherzustellen, dass sie mit den neuesten Änderungen im Projekt übereinstimmt.