Zum Hauptinhalt springen
Header

Voraussetzungen

  • Linux and MacOS
  • Windows (WSL)
Bevor Sie Twenty installieren und verwenden können, stellen Sie sicher, dass Sie Folgendes auf Ihrem Computer installiert haben:
npm wird nicht funktionieren, Sie sollten stattdessen yarn verwenden. Yarn wird jetzt mit Node.js geliefert, so dass Sie es nicht separat installieren müssen. Sie müssen nur corepack enable ausführen, um Yarn zu aktivieren, wenn Sie das noch nicht getan haben.

Schritt 1: Git klonen

Führen Sie in Ihrem Terminal den folgenden Befehl aus.

Schritt 2: Positionieren Sie sich im Stammverzeichnis

cd twenty
Alle folgenden Befehle innerhalb des Projekts sind vom Stammverzeichnis aus auszuführen.

Schritt 3: Einrichten einer PostgreSQL-Datenbank

  • Linux
  • Mac OS
  • Windows (WSL)
Option 1 (preferred): To provision your database locally: Use the following link to install Postgresql on your Linux machine: Postgresql Installation
  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Note: You might need to add sudo -u postgres to the command before psql to avoid permission errors.
**Option 2:** If you have docker installed:
```bash
  make postgres-on-docker
```
Sie können jetzt über localhost:5432 auf die Datenbank zugreifen, mit dem Benutzer postgres und dem Passwort postgres.

Schritt 4: Einrichten einer Redis-Datenbank (Cache)

Twenty benötigt einen Redis-Cache, um die beste Leistung zu bieten
  • Linux
  • Mac OS
  • Windows (WSL)
Option 1: To provision your Redis locally: Use the following link to install Redis on your Linux machine: Redis Installation
**Option 2:** If you have docker installed:
```bash
  make redis-on-docker
```
Wenn Sie eine Client-GUI benötigen, empfehlen wir redis insight (kostenlose Version verfügbar)

Schritt 5: Einrichten von Umgebungsvariablen

Verwenden Sie Umgebungsvariablen oder .env-Dateien, um Ihr Projekt zu konfigurieren. Weitere Informationen hier Kopieren Sie die .env.example-Dateien in /front und /server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env

Schritt 6: Abhängigkeiten installieren

Um den Twenty-Server zu bauen und einige Daten in Ihre Datenbank zu seeden, führen Sie den folgenden Befehl aus:
yarn
Bitte beachten Sie, npm oder pnpm funktionieren nicht.

Schritt 7: Das Projekt ausführen

  • Linux
  • Mac OS
  • Windows (WSL)
Je nach Ihrer Linux-Distribution könnte der Redis-Server automatisch gestartet werden. Wenn nicht, überprüfen Sie den Redis Installationsleitfaden für Ihre Distribution.
Richten Sie Ihre Datenbank mit folgendem Befehl ein:
npx nx database:reset twenty-server
Starten Sie den Server, den Worker und die Frontend-Dienste:
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
Alternativ können Sie alle Dienste auf einmal starten:
npx nx start

Schritt 8: Verwenden Sie Twenty

Frontend Das Frontend von Twenty läuft unter http://localhost:3001. Sie können sich mit dem Standard-Demokonto anmelden: tim@apple.dev (Passwort: tim@apple.dev) Backend

Fehlerbehebung

Sollten Sie auf ein Problem stoßen, schauen Sie sich die Fehlerbehebung für Lösungen an.