Nutzung

npx gtx-cli init

Verwenden Sie diesen Befehl, um den GT-Einrichtungsassistenten auszuführen.

Dieser Befehl entspricht dem Ausführen von setup und anschließend configure.

Der Assistent wird:

1. die erforderlichen Abhängigkeiten für Ihr Projekt installieren.
2. (bei Next.js) die Funktion withGTConfig zu Ihrer Datei next.config.js hinzufügen und die Komponente GTProvider einrichten.
3. die Datei gt.config.json im Projektstammverzeichnis erstellen.
4. einen API-Schlüssel und eine Projekt-ID für Ihr Projekt generieren.

Abhängigkeiten

Der Befehl init installiert die folgenden Abhängigkeiten für Ihr Projekt:

• gt-react oder gt-next (wenn Ihr Projekt auf React basiert)
• gtx-cli als Entwicklungsabhängigkeit (falls noch nicht installiert)

React-basierte Projekte

Wenn Ihr Projekt auf React basiert, unterstützt Sie der Assistent dabei, es für die Verwendung von gt-react oder gt-next einzurichten.

Wenn Sie bereits eine andere i18n-Bibliothek verwenden, müssen Sie Ihr Projekt möglicherweise manuell einrichten.

Weitere Informationen finden Sie in den React-Dokumenten oder in den Next.js-Dokumenten.

Da der Assistent derzeit experimentell ist, kann es sein, dass er nicht mit allen React-basierten Projekten funktioniert. In diesen Fällen müssen Sie Ihr Projekt möglicherweise manuell einrichten.

Wenn Sie auf Probleme stoßen, teilen Sie uns diese bitte auf GitHub mit.

Dieser Teil des Assistenten kann auch unabhängig über npx gtx-cli setup ausgeführt werden.

gt.config.json

Der Befehl init hilft Ihnen, die GT-Einstellungen Ihres Projekts zu konfigurieren.

Er legt im Projektstamm eine Datei gt.config.json an.

Die Datei enthält die folgenden Einstellungen:

• defaultLocale: Die Standard-Locale Ihres Projekts.
• locales: Ein Array der unterstützten Locales Ihres Projekts.
• files: Ein Objekt mit Informationen zu den Inhalten, die Sie übersetzen möchten.

Ausführlichere Informationen zur Datei gt.config.json finden Sie in der Konfigurationsdokumentation.

Diesen Schritt des Assistenten können Sie auch eigenständig mit npx gtx-cli configure ausführen.

Zugangsdaten

Der Assistent hilft Ihnen, einen API-Schlüssel und eine Projekt-ID für Ihr Projekt zu erstellen (falls diese noch nicht eingerichtet sind).

Bitte beachten Sie, dass der API-Schlüssel und die Projekt-ID nicht erforderlich sind, um gt-react oder gt-next zu verwenden.

Der Assistent fügt den API-Schlüssel und die Projekt-ID Ihrer Datei .env.local hinzu. Falls diese Datei nicht existiert, erstellt der Assistent sie und trägt sie in Ihre .gitignore-Datei ein.

Diesen Teil des Assistenten können Sie auch unabhängig mit npx gtx-cli auth ausführen.