Installationsanleitung
Diese Anleitung hilft Ihnen dabei, unsere Plattform schnell zu installieren und zu konfigurieren.
Systemanforderungen
Mindestanforderungen
- Node.js: 18.0.0 oder höher
- npm: 8.0.0 oder höher
- pnpm: 8.0.0 oder höher (empfohlen)
- Arbeitsspeicher: 4GB RAM
- Speicherplatz: 2GB verfügbarer Speicher
Empfohlene Konfiguration
- Node.js: 20.0.0 oder höher
- Arbeitsspeicher: 8GB RAM
- Speicherplatz: 5GB verfügbarer Speicher
- Betriebssystem: macOS 12+, Ubuntu 20.04+, Windows 10+
Installationsschritte
1. Projekt klonen
git clone https://github.com/your-org/woker-job.git
cd woker-job
2. Abhängigkeiten installieren
Verwenden Sie pnpm (empfohlen):
pnpm install
Oder verwenden Sie npm:
npm install
3. Umgebung konfigurieren
Umgebungsvariablen-Datei kopieren:
cp .env.example .env
Die .env
-Datei bearbeiten, um die notwendigen Umgebungsvariablen zu konfigurieren:
# Datenbank-Konfiguration
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"
# JWT-Geheimnis
JWT_SECRET="your-jwt-secret-key"
# Frontend-Konfiguration
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"
4. Datenbank einrichten
Docker verwenden (Empfohlen)
# PostgreSQL-Datenbank starten
docker run --name woker-job-db \
-e POSTGRES_DB=woker_job \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=password \
-p 5432:5432 \
-d postgres:15
Manuelle PostgreSQL-Installation
- PostgreSQL herunterladen und installieren
- Datenbank erstellen:
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;
5. Datenbank-Migrationen ausführen
# Zum Backend-Verzeichnis wechseln
cd apps/back-end
# Migrationen ausführen
pnpm run migration:run
6. Entwicklungsserver starten
Alle Services starten (Empfohlen)
Im Projektverzeichnis:
pnpm run dev
Services einzeln starten
Backend-Service:
cd apps/back-end
pnpm run start:dev
Frontend-Service:
cd apps/web
pnpm run dev
7. Installation überprüfen
- Frontend-Anwendung aufrufen: http://localhost:3000
- Backend-API aufrufen: http://localhost:3001
- API-Dokumentation prüfen: http://localhost:3001/api
Produktionsbereitstellung
Docker-Bereitstellung
- Image erstellen:
docker build -t woker-job .
- Container ausführen:
docker run -d \
--name woker-job \
-p 3000:3000 \
-p 3001:3001 \
-e DATABASE_URL="your-production-db-url" \
woker-job
Manuelle Bereitstellung
- Produktionsversion erstellen:
pnpm run build
- Produktionsservices starten:
pnpm run start
Häufige Probleme
Port-Konflikte
Wenn die Ports 3000 oder 3001 belegt sind, können Sie die Umgebungsvariablen ändern:
# Frontend-Port
PORT=3002
# Backend-Port
BACKEND_PORT=3003
Datenbankverbindungsfehler
- Prüfen, ob der Datenbankservice läuft
- Verbindungsstring-Format überprüfen
- Firewall-Einstellungen bestätigen
Abhängigkeitsinstallationsfehler
- Cache leeren:
pnpm store prune
npm cache clean --force
- node_modules löschen und neu installieren:
rm -rf node_modules
pnpm install
Nächste Schritte
Nach der Installation können Sie:
- Schnellstart - Grundlegende Verwendung erlernen
- Konzepte - Kernkonzepte erlernen
- API-Dokumentation - API-Referenz anzeigen
- Konfigurationsanleitung - Erweiterte Konfiguration erlernen
Hilfe erhalten
Bei Problemen während der Installation:
- Fehlerbehebung-Anleitung prüfen
- GitHub Issues prüfen
- Technisches Support-Team kontaktieren