设置向导
运行 GT 设置向导
使用方法
npx gtx-cli init
使用此命令运行 GT 设置向导。
此命令等同于先运行 setup
,然后运行 configure
。
向导将:
- 为您的项目安装必要的依赖项。
- 帮助您用
<T>
标签包装 JSX 内容(在基于 React 的项目中)。 - 在项目根目录中创建
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(如果尚未设置)。
请注意,使用gt-react
或gt-next
不需要API密钥和项目ID。
向导将把API密钥和项目ID添加到您的.env.local
文件中。
如果该文件不存在,向导将创建它并将其添加到您的.gitignore
文件中。
向导的这一部分也可以通过npx gtx-cli auth
单独运行。
这份指南怎么样?