Asistente de configuración

Ejecuta el asistente de configuración de GT

Uso

npx gtx-cli init

Usa este comando para ejecutar el asistente de configuración de GT.

Este comando equivale a ejecutar setup y luego configure.

El asistente hará lo siguiente:

  1. Instalar las dependencias necesarias para tu proyecto.
  2. (Si usas Next.js) Agregar la función withGTConfig a tu archivo next.config.js y configurar el componente GTProvider.
  3. Crear un archivo gt.config.json en la raíz de tu proyecto.
  4. Generar una clave de API y un id de proyecto para tu proyecto.

Dependencias

El comando init instalará las siguientes dependencias para tu proyecto:

  • gt-react o gt-next (si tu proyecto usa React)
  • gtx-cli como dependencia de desarrollo (si aún no está instalada)

Proyectos basados en React

Si tu proyecto está basado en React, el asistente te ayudará a configurar tu proyecto para usar gt-react o gt-next.

Si ya usas otra biblioteca de i18n, quizá debas configurar tu proyecto manualmente.

Consulta la documentación de React o la documentación de Next.js para más información.

Dado que el asistente es experimental, es posible que no funcione en todos los proyectos basados en React. En esos casos, quizá debas configurar tu proyecto manualmente.

Si encuentras algún problema, avísanos en GitHub.

Esta parte del asistente también puede ejecutarse de forma independiente con npx gtx-cli setup.

gt.config.json

El comando init te ayuda a configurar los ajustes de GT de tu proyecto.

Creará un archivo gt.config.json en la raíz de tu proyecto.

El archivo contendrá los siguientes ajustes:

  • defaultLocale: El locale predeterminado de tu proyecto.
  • locales: Una matriz de locales compatibles para tu proyecto.
  • files: Un objeto que contiene información sobre el contenido que deseas traducir.

Para obtener información más detallada sobre el archivo gt.config.json, consulta la documentación de configuración.

Esta parte del asistente también se puede ejecutar de forma independiente con npx gtx-cli configure.

Credenciales

El asistente te ayudará a generar una clave de API y un ID de proyecto para tu proyecto (si aún no están configurados).

Ten en cuenta que la clave de API y el ID de proyecto no son necesarios para usar gt-react o gt-next.

El asistente añadirá la clave de API y el ID de proyecto a tu archivo .env.local. Si este archivo no existe, el asistente lo creará y lo añadirá a tu archivo .gitignore.

Esta parte del asistente también se puede ejecutar de forma independiente con npx gtx-cli auth.

¿Qué te ha parecido esta guía?

Asistente de configuración