Documentation Index
Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
Use this file to discover all available pages before exploring further.
Voraussetzungen
Linux und 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.
- Installieren Sie WSL
Öffnen Sie PowerShell als Administrator und führen Sie aus:
Sie sollten nun eine Aufforderung sehen, Ihren Computer neu zu starten. Wenn nicht, starten Sie ihn manuell neu.Nach dem Neustart wird ein PowerShell-Fenster geöffnet und Ubuntu installiert. Dies kann einige Zeit in Anspruch nehmen.
Sie werden aufgefordert, einen Benutzernamen und ein Passwort für Ihre Ubuntu-Installation zu erstellen.
- Git installieren und konfigurieren
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- nvm, node.js und yarn installieren
Verwenden Sie nvm, um die korrekte node-Version zu installieren. Die .nvmrc stellt sicher, dass alle Mitwirkenden die gleiche Version verwenden.
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
nvm install # installiert empfohlene node-Version
nvm use # verwendet empfohlene node-Version
corepack enable
Schritt 1: Git klonen
Führen Sie in Ihrem Terminal den folgenden Befehl aus.
Wenn Sie SSH-Schlüssel noch nicht eingerichtet haben, können Sie hier erfahren, wie das geht.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Schritt 2: Positionieren Sie sich im Stammverzeichnis
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 (bevorzugt): Um Ihre Datenbank lokal bereitzustellen:
Verwenden Sie den folgenden Link, um PostgreSQL auf Ihrem Linux-Rechner zu installieren: PostgreSQL-Installation psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres dem Befehl vor psql hinzufügen, um Berechtigungsfehler zu vermeiden.Option 2: Wenn Sie Docker installiert haben: make -C packages/twenty-docker postgres-on-docker
Option 1 (bevorzugt): Um Ihre Datenbank lokal mit brew bereitzustellen: brew install postgresql@16
export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
brew services start postgresql@16
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
postgres möglicherweise nicht standardmäßig bei der Installation
über Homebrew auf macOS. Stattdessen wird eine PostgreSQL-Rolle erstellt, die Ihrem macOS
Benutzernamen (z. B. “john”) entspricht.
Um zu überprüfen und, falls erforderlich, den Benutzer postgres zu erstellen, führen Sie folgende Schritte aus: # Verbinden Sie sich mit PostgreSQL
psql postgres
oder
psql -U $(whoami) -d postgres
# Vorhandene PostgreSQL-Rollen auflisten
\du
Rolle Name | Attribute | Mitglied von
-----------+-------------+-----------
john | Superuser | {}
postgres-Rolle sehen, fahren Sie mit dem nächsten Schritt fort.
Erstellen Sie die Rolle postgres manuell: CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres mit Anmeldezugriff erstellt.Rollenname | Attribute | Mitglied von
-----------+-------------+-----------
postgres | Superuser | {}
john | Superuser | {}
make -C packages/twenty-docker postgres-on-docker
Alle folgenden Schritte sind im WSL-Terminal auszuführen (innerhalb Ihrer virtuellen Maschine)Option 1: Um Ihr PostgreSQL lokal bereitzustellen:
Verwenden Sie den folgenden Link, um PostgreSQL auf Ihrer Linux-VM zu installieren: PostgreSQL-Installation psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres dem Befehl vor psql hinzufügen, um Berechtigungsfehler zu vermeiden.Option 2: Wenn Sie Docker installiert haben:
Die Ausführung von Docker auf WSL fügt eine zusätzliche Komplexitätsschicht hinzu.
Verwenden Sie diese Option nur, wenn Sie mit den zusätzlichen Schritten vertraut sind, einschließlich der Aktivierung von Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
localhost:5432 auf die Datenbank zugreifen.
Wenn Sie die oben genannte Docker-Option verwendet haben, lauten die Standardanmeldedaten Benutzer postgres und Passwort postgres. Für native PostgreSQL-Installationen verwenden Sie die auf Ihrem Rechner konfigurierten Anmeldedaten und Rollen.
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: Bereitstellung von Redis lokal:
Verwenden Sie den folgenden Link, um Redis auf Ihrem Linux-Rechner zu installieren: Redis InstallationOption 2: Wenn Sie Docker installiert haben: make -C packages/twenty-docker redis-on-docker
Option 1 (bevorzugt): Bereitstellung von Redis lokal mit brew:Starten Sie Ihren Redis-Server:brew services start redis
make -C packages/twenty-docker redis-on-docker
Option 1: Um Redis lokal bereitzustellen:
Verwenden Sie den folgenden Link, um Redis auf Ihrer Linux-VM zu installieren: Redis-InstallationOption 2: Wenn Sie Docker installiert haben: make -C packages/twenty-docker redis-on-docker
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
Multi-Workspace-Modus: Standardmäßig läuft Twenty im Einzel-Workspace-Modus, in dem nur ein Workspace erstellt werden kann. Um die Multi-Workspace-Unterstützung zu aktivieren (nützlich zum Testen von Subdomain-basierten Funktionen), setzen Sie IS_MULTIWORKSPACE_ENABLED=true in der .env-Datei Ihres Servers. Siehe Multi-Workspace-Modus für Details. 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:
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. Redis sollte bereits laufen. Falls nicht, führen Sie aus:brew services start redis
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. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
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.