セットアップウィザード

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

使い方

npx gtx-cli init

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

このコマンドは、setup を実行し、その後に configure を実行するのと同じです。

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

  1. プロジェクトに必要な依存関係をインストールします。
  2. (Next.js の場合)next.config.jswithGTConfig 関数を追加し、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 で単独実行することもできます。

このガイドはどうでしたか?

セットアップウィザード