1.1.5 • Published 6 months ago

plai-widget-core v1.1.5

Weekly downloads
-
License
ISC
Repository
-
Last release
6 months ago

Instrucciones de integración

Para proceder con la integración del widget en su proyecto debe seguir los siguientes pasos:

  • Abra una nueva terminal en la carpeta raíz de su proyecto.
  • Ejecute el siguiente comando para instalar la ultima versión del widget:
npx plai-widget-core@latest
  • Si el proceso de instalacion fue exitoso, deberia visualizar el siguiente mensaje en su terminal:
Integración exitosa! (/path/to/project/index.html)

para poder comprobar que el widget se ha integrado correctamente, debe abrir el archivo index.html de su proyecto y verificar que se haya agregado la siguiente etiqueta script:

  <!-- widget -->
      <div id="rootWidget"></div>
      <script defer>
        window.Plai = <token de configuración>;
      </script>
      <script type="module" defer src=<ruta remota></script>
  <!-- end widget -->

Argumentos adicionales (opcional)

Tambien al ejecutar el comando npx plai-widget-core@latest puede agregar los siguientes argumentos:

--config: Especifica el token de configuración perzonalizado
--env: especifica en que entorno se ejecutara el widget (dev, test, prod)

Si no se especifica el token de configuración, el widget se ejecutara con la configuración por defecto (apuntando al chat GPT nativo), si no especifica el entorno, el widget se ejecutara en el entorno de producción (prod).

Nota: El argumento --env esta pensado para uso en ambientes de desarrollo, por lo que no es necesario especificarlo en ambientes de producción.

Ejemplo de uso

npx plai-widget-core@latest --config=<token> --env=<env>

Es necesario especificar el token de configuración para poder ejecutar el widget en su proyecto. De lo contrario el widget se ejecutara con la configuración por defecto (apuntando al chat GPT nativo).

Change log

  • 1.0.0: Primera versión del pkg de integración
  • 1.0.1: Se agrega logica de extraccion de archivos desde el repo del proyecto
  • 1.1.0: Modificación de logica y optimización de la instalación ya no se importa ningun repo externo, solo se agrega la etiqueta script y se añaden algunas validaciones extras.
  • 1.1.1: Se agrega validación de token de configuración segun variable de entorno seleccionada.
  • 1.1.2: Modificacion de ruta de lectura de archivo script.txt
  • 1.1.3: Modificacion de ruta de lectura de archivo script.txt se agrega path absoluto
  • 1.1.4: Modificacion de los tokens de configuracion basicos apuntando a sus respectivos ambientes
  • 1.1.5: Modificacion de README.md (Modificacion de comando para la instalacion del widget @latest)
1.1.5

6 months ago

1.1.4

6 months ago

1.1.3

6 months ago

1.1.2

6 months ago

1.1.1

6 months ago

1.1.0

6 months ago

1.0.1

6 months ago

1.0.0

6 months ago