设置向导

运行 GT 设置向导

依赖

init 命令会为你的项目安装以下依赖:

  • gt-reactgt-next(如果你的项目使用 React)
  • gtx-cli 作为开发依赖安装(如果尚未安装)

基于 React 的项目

如果你的项目基于 React,向导会帮助你配置以使用 gt-reactgt-next

如果你已经在使用其他 i18n 库,可能需要手动完成项目配置。

参见 React 文档Next.js 文档 了解更多信息。

由于该向导目前为实验性功能,可能无法适配所有基于 React 的项目。 在这种情况下,你可能需要手动配置项目。

如果遇到任何问题,请在 GitHub 提交反馈。

该向导的此部分也可通过 npx gtx-cli setup 独立运行。

gt.config.json

init 命令可帮助你配置项目的 GT 设置。

它会在项目根目录创建一个 gt.config.json 文件。

该文件将包含以下设置:

  • defaultLocale:项目的默认 locale。
  • locales:项目的受支持的 locales 数组。
  • files:一个对象,包含你要翻译的内容相关信息。

有关 gt.config.json 的更详尽说明,请参阅配置文档

向导的这一部分也可以通过 npx gtx-cli configure 独立运行。

凭据

向导将帮助你为项目生成 API key 和项目 ID(如果尚未设置)。

请注意,使用 gt-reactgt-next 并不需要 API key 和项目 ID。

向导会将 API key 和项目 ID 添加到你的 .env.local 文件中。 如果该文件不存在,向导会创建该文件,并将其添加到你的 .gitignore 中。

此向导的这一步也可以通过 npx gtx-cli auth 独立运行。

这份指南怎么样?

设置向导