Files
twenty/packages/twenty-docs/l/de/developers/contribute/capabilities/local-setup.mdx
T
cd73088be6 i18n - docs translations (#19925)
Created by Github action

Co-authored-by: github-actions <github-actions@twenty.com>
2026-04-21 10:57:27 +02:00

319 lines
11 KiB
Plaintext

---
title: Lokale Einrichtung
icon: laptop-code
description: Der Leitfaden für Mitwirkende (oder neugierige Entwickler), die Twenty lokal ausführen möchten.
---
## Voraussetzungen
<Tabs>
<Tab title="Linux und macOS">
Bevor Sie Twenty installieren und verwenden können, stellen Sie sicher, dass Sie Folgendes auf Ihrem Computer installiert haben:
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Node v24.5.0](https://nodejs.org/en/download)
* [yarn v4](https://yarnpkg.com/getting-started/install)
* [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)
<Warning>
`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.
</Warning>
</Tab>
<Tab title="Windows (WSL)">
1. Installieren Sie WSL
Öffnen Sie PowerShell als Administrator und führen Sie aus:
```powershell
wsl --install
```
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.
2. Git installieren und konfigurieren
```bash
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
```
3. nvm, node.js und yarn installieren
<Warning>
Verwenden Sie `nvm`, um die korrekte `node`-Version zu installieren. Die `.nvmrc` stellt sicher, dass alle Mitwirkenden die gleiche Version verwenden.
</Warning>
```bash
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
```
Schließen und öffnen Sie Ihr Terminal erneut, um nvm zu verwenden. Führen Sie dann die folgenden Befehle aus.
```bash
nvm install # installiert empfohlene node-Version
nvm use # verwendet empfohlene node-Version
corepack enable
```
</Tab>
</Tabs>
---
## Schritt 1: Git klonen
Führen Sie in Ihrem Terminal den folgenden Befehl aus.
<Tabs>
<Tab title="SSH (Empfohlen)">
Wenn Sie SSH-Schlüssel noch nicht eingerichtet haben, können Sie [hier](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) erfahren, wie das geht.
```bash
git clone git@github.com:twentyhq/twenty.git
```
</Tab>
<Tab title="HTTPS">
```bash
git clone https://github.com/twentyhq/twenty.git
```
</Tab>
</Tabs>
## Schritt 2: Positionieren Sie sich im Stammverzeichnis
```bash
cd twenty
```
Alle folgenden Befehle innerhalb des Projekts sind vom Stammverzeichnis aus auszuführen.
## Schritt 3: Einrichten einer PostgreSQL-Datenbank
<Tabs>
<Tab title="Linux">
**Option 1 (bevorzugt):** Um Ihre Datenbank lokal bereitzustellen:
Verwenden Sie den folgenden Link, um PostgreSQL auf Ihrem Linux-Rechner zu installieren: [PostgreSQL-Installation](https://www.postgresql.org/download/linux/)
```bash
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
```
Hinweis: Möglicherweise müssen Sie `sudo -u postgres` dem Befehl vor `psql` hinzufügen, um Berechtigungsfehler zu vermeiden.
**Option 2:** Wenn Sie Docker installiert haben:
```bash
make -C packages/twenty-docker postgres-on-docker
```
</Tab>
<Tab title="Mac OS">
**Option 1 (bevorzugt):** Um Ihre Datenbank lokal mit `brew` bereitzustellen:
```bash
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;"
```
Sie können überprüfen, ob der PostgreSQL-Server läuft, indem Sie folgendes ausführen:
```bash
brew services list
```
Das Installationsprogramm erstellt den Benutzer `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:
```bash
# Verbinden Sie sich mit PostgreSQL
psql postgres
oder
psql -U $(whoami) -d postgres
```
Sobald Sie sich an der psql-Eingabeaufforderung (postgres=#) befinden, führen Sie aus:
```bash
# Vorhandene PostgreSQL-Rollen auflisten
\du
```
Sie werden eine Ausgabe ähnlich der folgenden sehen:
```bash
Rolle Name | Attribute | Mitglied von
-----------+-------------+-----------
john | Superuser | {}
```
Wenn Sie keine `postgres`-Rolle sehen, fahren Sie mit dem nächsten Schritt fort.
Erstellen Sie die Rolle `postgres` manuell:
```bash
CREATE ROLE postgres WITH SUPERUSER LOGIN;
```
Dadurch wird eine Superuser-Rolle namens `postgres` mit Anmeldezugriff erstellt.
```bash
Rollenname | Attribute | Mitglied von
-----------+-------------+-----------
postgres | Superuser | {}
john | Superuser | {}
```
**Option 2:** Wenn Sie Docker installiert haben:
```bash
make -C packages/twenty-docker postgres-on-docker
```
</Tab>
<Tab title="Windows (WSL)">
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](https://www.postgresql.org/download/linux/)
```bash
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
```
Hinweis: Möglicherweise müssen Sie `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](https://docs.docker.com/desktop/wsl).
```bash
make -C packages/twenty-docker postgres-on-docker
```
</Tab>
</Tabs>
Sie können nun über `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.
<Tabs>
<Tab title="Linux">
**Option 1:** Bereitstellung von Redis lokal:
Verwenden Sie den folgenden Link, um Redis auf Ihrem Linux-Rechner zu installieren: [Redis Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)
**Option 2:** Wenn Sie Docker installiert haben:
```bash
make -C packages/twenty-docker redis-on-docker
```
</Tab>
<Tab title="Mac OS">
**Option 1 (bevorzugt):** Bereitstellung von Redis lokal mit `brew`:
```bash
brew install redis
```
Starten Sie Ihren Redis-Server:
```bash
brew services start redis
```
**Option 2:** Wenn Sie Docker installiert haben:
```bash
make -C packages/twenty-docker redis-on-docker
```
</Tab>
<Tab title="Windows (WSL)">
**Option 1:** Um Redis lokal bereitzustellen:
Verwenden Sie den folgenden Link, um Redis auf Ihrer Linux-VM zu installieren: [Redis-Installation](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/)
**Option 2:** Wenn Sie Docker installiert haben:
```bash
make -C packages/twenty-docker redis-on-docker
```
</Tab>
</Tabs>
Wenn Sie eine Client-GUI benötigen, empfehlen wir [Redis Insight](https://redis.io/insight/) (kostenlose Version verfügbar).
## Schritt 5: Einrichten von Umgebungsvariablen
Verwenden Sie Umgebungsvariablen oder `.env`-Dateien, um Ihr Projekt zu konfigurieren. Weitere Informationen [hier](/l/de/developers/self-host/capabilities/setup).
Kopieren Sie die `.env.example`-Dateien in `/front` und `/server`:
```bash
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
```
<Info>
**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](/l/de/developers/self-host/capabilities/setup#multi-workspace-mode) für Details.
</Info>
## 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:
```bash
yarn
```
Bitte beachten Sie, `npm` oder `pnpm` funktionieren nicht.
## Schritt 7: Das Projekt ausführen
<Tabs>
<Tab title="Linux">
Je nach Ihrer Linux-Distribution könnte der Redis-Server automatisch gestartet werden.
Wenn nicht, überprüfen Sie den [Redis Installationsleitfaden](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) für Ihre Distribution.
</Tab>
<Tab title="Mac OS">
Redis sollte bereits laufen. Falls nicht, führen Sie aus:
```bash
brew services start redis
```
</Tab>
<Tab title="Windows (WSL)">
Je nach Ihrer Linux-Distribution könnte der Redis-Server automatisch gestartet werden.
Wenn nicht, überprüfen Sie den [Redis Installationsleitfaden](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) für Ihre Distribution.
</Tab>
</Tabs>
Richten Sie Ihre Datenbank mit folgendem Befehl ein:
```bash
npx nx database:reset twenty-server
```
Starten Sie den Server, den Worker und die Frontend-Dienste:
```bash
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
```
Alternativ können Sie alle Dienste auf einmal starten:
```bash
npx nx start
```
## Schritt 8: Verwenden Sie Twenty
**Frontend**
Das Frontend von Twenty läuft unter [http://localhost:3001](http://localhost:3001).
Sie können sich mit dem Standard-Demokonto anmelden: `tim@apple.dev` (Passwort: `tim@apple.dev`)
**Backend**
* Der Server von Twenty wird unter [http://localhost:3000](http://localhost:3000) verfügbar sein.
* Die GraphQL-API kann unter [http://localhost:3000/graphql](http://localhost:3000/graphql) erreicht werden.
* Die REST-API ist erreichbar unter [http://localhost:3000/rest](http://localhost:3000/rest)
## Fehlerbehebung
Sollten Sie auf ein Problem stoßen, schauen Sie sich die [Fehlerbehebung](/l/de/developers/self-host/capabilities/troubleshooting) für Lösungen an.