セットアップウィザード
GTセットアップウィザードを実行する
使い方
npx gtx-cli init
このコマンドで GT のセットアップウィザードを実行します。
このコマンドは、setup
を実行してから configure
を実行するのと同じです。
ウィザードは次の処理を行います:
- プロジェクトに必要な依存関係をインストールします。
- (Next.js の場合)
next.config.js
にwithGTConfig
関数を追加し、GTProvider
コンポーネントをセットアップします。 - プロジェクトのルートに
gt.config.json
ファイルを作成します。 - プロジェクト用の 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(まだ設定されていない場合)の生成をサポートします。
APIキーとプロジェクトIDは、gt-react
またはgt-next
を使用するために必須ではないことにご注意ください。
ウィザードはAPIキーとプロジェクトIDを.env.local
ファイルに追加します。
このファイルが存在しない場合、ウィザードはそれを作成し、.gitignore
ファイルに追加します。
ウィザードのこの部分は、npx gtx-cli auth
を使用して独立して実行することもできます。
このガイドはいかがですか?