Мастер настройки

Запустите мастер настройки GT

Использование

npx gtx-cli init

Используйте эту команду, чтобы запустить мастер настройки GT.

Эта команда равнозначна последовательному запуску setup, а затем configure.

Мастер выполнит:

  1. Установит необходимые зависимости для вашего проекта.
  2. (Если используется Next.js) Добавит функцию withGTConfig в файл next.config.js и настроит компонент GTProvider.
  3. Создаст файл gt.config.json в корне проекта.
  4. Сгенерирует API‑ключ и идентификатор проекта для вашего проекта.

Зависимости

Команда init установит для вашего проекта следующие зависимости:

  • gt-react или gt-next (если ваш проект на React)
  • gtx-cli как dev-зависимость (если ещё не установлен)

Проекты на 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 и идентификатор проекта для вашего проекта (если они еще не настроены).

Обратите внимание, что ключ API и идентификатор проекта не обязательны для использования gt-react или gt-next.

Мастер добавит ключ API и идентификатор проекта в файл .env.local. Если этого файла нет, мастер создаст его и добавит в файл .gitignore.

Эту часть мастера можно также запускать отдельно через npx gtx-cli auth.

Насколько полезно это руководство?

Мастер настройки