セットアップウィザード

GT のセットアップウィザードを実行する

使い方

npx gtx-cli init

GT のセットアップウィザードを実行するには、このコマンドを使用します。

このコマンドは、setup を実行してから configure を実行するのと同じです。

ウィザードでは次の処理を行います:

  1. プロジェクトに必要な依存関係をインストールします。
  2. (Next.js の場合)withGTConfig 関数を next.config.js に追加し、GTProvider コンポーネントをセットアップします。
  3. プロジェクトのルートに gt.config.json ファイルを作成します。
  4. プロジェクト用の APIキー とプロジェクトIDを生成します。

依存関係

init コマンドは、プロジェクトに次の依存関係をインストールします。

  • gt-react または gt-next(プロジェクトが React ベースの場合)
  • gtx-cli(未インストールの場合は開発依存関係として)

Reactベースのプロジェクト

プロジェクトがReactベースの場合、ウィザードはgt-reactまたはgt-nextの利用に必要な設定を行います。

すでに別のi18nライブラリを使用している場合は、手動で設定する必要がある場合があります。

詳細はReactのドキュメントまたはNext.jsのドキュメントをご参照ください。

ウィザードは現在実験段階のため、すべてのReactベースのプロジェクトで動作しない可能性があります。 その場合は、手動で設定していただく必要があります。

問題が発生した場合は、GitHubまでお知らせください。

このウィザードの該当部分は、npx gtx-cli setupで単独実行することもできます。

gt.config.json

init コマンドは、プロジェクトの GT 設定の初期設定を支援します。

プロジェクトのルートに gt.config.json ファイルが作成されます。

ファイルには次の設定が含まれます:

  • defaultLocale: プロジェクトの既定のロケール。
  • locales: プロジェクトの対応ロケールの配列。
  • files: 翻訳対象のコンテンツに関する情報を持つオブジェクト。

gt.config.json ファイルの詳細については、設定ドキュメントを参照してください。

このウィザードのこのセクションは、npx gtx-cli configure で個別に実行することもできます。

資格情報

ウィザードは(まだ設定されていない場合)、プロジェクトの APIキー とプロジェクトIDを生成するのに役立ちます。

gt-reactgt-next を使用するために、APIキー とプロジェクトIDは必須ではありません。

ウィザードは APIキー とプロジェクトIDを .env.local ファイルに追加します。 このファイルが存在しない場合は、ウィザードが作成し、.gitignore にも追加します。

このウィザードのこの機能は、npx gtx-cli auth で単独実行することもできます。

このガイドはいかがですか?