# Primeros pasos

Inicializa y publica un widget localmente utilizando Modyo CLI.

# Prerequisitos

Esta guía fue creada para usuarios que ya tienen conocimiento de los siguientes temas:

# Instalar Modyo-CLI

La interface de línea de comandos de Modyo te permite interactuar con la plataforma y nuestro catálogo de widgets desde una terminal. Para instalarla, corre el comando:

Vía yarn

$ yarn global add @modyo/cli

Vía npm

$ npm i -g @modyo/cli

Verifica que la instalación fue correcta usando el comando: modyo-cli help

# Inicializar un Widget

La manera mas rápida de inicializar un Widget, es utilizando una de las plantillas de este catálogo como acelerador y modificarlo para tus necesidades. Puedes encontrar el <nombre-del-Widget como parte de la documentación del Widget.

  1. Usa el comando get de modyo-cli para descargar los archivos necesarios para el widget:
modyo-cli get <nombre-del-Widget> <directorioDestino>

Por ejemplo si queremos usar la plantilla de Crédito de Consumo de la Banca de Personas el comando sería el siguiente:

modyo-cli get modyo-widgets-retail-consumer-loan ~/Desktop/MyLoanWidget
  1. Cambia de directorio e inicializa el servidor en modo de desarrollo:
cd ~/Desktop/MyLoanWidget && yarn serve

Alerta

Si encuentras problemas para compilar, prueba instalar una version compatible de postCSS con esta linea

npm i -D @fullhuman/postcss-purgecss@3.0.0 postcss@7.0.351

# Publicar un Widget

Para cargar nuestro Widget a la plataforma y publicarlo, usaremos el comando push de modyo-cli. Esto se puede hacer de manera local o usando integración continua (recomendado).

  1. Crea un archivo de variables de entorno .env en la raíz del proyecto con las siguientes variables:
MODYO_ACCOUNT_URL=[accountUrl] //URL de la cuenta dueña del sitio
MODYO_VERSION=9                //La versión de la plataforma Modyo
MODYO_TOKEN=[siteToken]        //El token para accesar a la API administrativa
MODYO_SITE_HOST=[siteHost]     //El nombre de Host, localizado dentro de la plataforma, en la sección de sitios
MODYO_WIDGET_NAME=[widgetName] //El nombre del widget
MODYO_BUILD_COMMAND=build      //El comando para package.json (default: build) 
MODYO_BUILD_DIRECTORY=dist     //La ruta del widget (default: dist) 

En caso de no usar un archivo de variables de entorno, también se pueden mandar los datos necesarios directamente desde la línea de comandos. Por ejemplo:

modyo-cli push miWidget -b build -d dist -n miHost -v 9 -u "https://test.miModyo.com" -t $TOKEN 

Tip

Para saber más acerca de como obtener un token de acceso a la API, ve API de administración

Para saber todas las opciones disponibles para modyo-cli push, ve Modyo-CLI Push

Image displaying where to find accountURL and siteHost
  1. Abre una terminal en el proyecto y usa push para enviar el widget a la plataforma:
modyo-cli push

Una vez terminado el proceso de carga, el Widget estará disponible en la sección Widgets de nuestro sitio esperando para ser revisado y publicado.

Image displaying your new Widget in Modyo Platform

Si queremos que el Widget se publique automáticamente al terminar la carga, podemos usar la opción --publish.

modyo-cli push --publish
Last Updated: 10/10/2022,