Einrichtungsassistent

Den GT-Einrichtungsassistenten ausführen

Verwendung

npx gtx-cli init

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

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

Der Assistent wird:

  1. Die notwendigen Abhängigkeiten für Ihr Projekt installieren.
  2. Ihnen dabei helfen, Ihren JSX-Inhalt mit <T>-Tags zu umschließen (in einem React-basierten Projekt).
  3. Eine gt.config.json-Datei im Stammverzeichnis Ihres Projekts 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 React-basiert ist)
  • gtx-cli als Dev-Abhängigkeit (falls noch nicht installiert)

React-basierte Projekte

Wenn Ihr Projekt React-basiert ist, hilft Ihnen der Assistent dabei, Ihr Projekt für die Verwendung von gt-react oder gt-next einzurichten.

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

Weitere Informationen finden Sie in der React-Dokumentation oder der Next.js-Dokumentation.

Da der Assistent derzeit experimentell ist, kann es vorkommen, dass er nicht für alle React-basierten Projekte funktioniert. In diesen Fällen müssen Sie Ihr Projekt möglicherweise manuell einrichten.

Falls Sie auf Probleme stoßen, lassen Sie es uns bitte auf GitHub wissen.

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

gt.config.json

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

Er erstellt eine gt.config.json Datei im Stammverzeichnis Ihres Projekts.

Die Datei enthält die folgenden Einstellungen:

  • defaultLocale: Die Standard-Locale für Ihr Projekt.
  • locales: Ein Array von unterstützten Locales für Ihr Projekt.
  • files: Dies ist ein Objekt, das Informationen über den Inhalt enthält, den Sie übersetzen möchten.

Für spezifischere Informationen über die gt.config.json Datei, siehe bitte die Konfigurationsdokumentation.

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

Anmeldedaten

Der Assistent hilft Ihnen, einen API-Schlüssel und eine Projekt-ID für Ihr Projekt zu generieren (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 zu Ihrer .env.local-Datei hinzu. Wenn diese Datei nicht existiert, wird der Assistent sie erstellen und zu Ihrer .gitignore-Datei hinzufügen.

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

Wie ist dieser Leitfaden?