设置向导
运行 GT 设置向导
用法
npx gtx-cli init使用此命令启动 GT 安装向导。
该命令相当于先运行 setup,再运行 configure。
向导将:
- 为你的项目安装所需依赖。
- (如果使用 Next.js)将
withGTConfig函数添加到你的next.config.js文件,并完成GTProvider组件的设置。 - 在项目根目录创建
gt.config.json文件。 - 为你的项目生成 API key 和项目 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: 项目的默认 locale。locales: 项目的受支持的 locales 数组。files: 一个对象,包含你需要 translate 的内容信息。
有关 gt.config.json 的更多详细信息,请参见配置文档。
向导的这一部分也可以通过 npx gtx-cli configure 独立运行。
凭据
向导会帮助你为项目生成 API key 和项目 ID(如果尚未设置)。
请注意,使用 gt-react 或 gt-next 并不需要 API key 和项目 ID。
向导会将 API key 和项目 ID 添加到你的 .env.local 文件中。
如果该文件不存在,向导会创建该文件,并将其添加到你的 .gitignore 中。
此部分向导也可通过 npx gtx-cli auth 独立运行。
本指南如何?