Skip to content

Instrucciones para colaborar con wengy ven

Jump to bottom
Leonardo Cabeza edited this page May 25, 2020 · 1 revision

Bienvenidos.

Aquí se va a explicar paso a paso como configurar un ambiente de producción para probar al bot y que les simplifique la vida a los futuros colaboradores.

Guía actualizada para version v4.0.0

  1. Lo primero que debemos hacer, es hacer un fork.

    1.1 Descargamos e instalamos una versión mayor a la 10 en NodeJS

  2. Luego clonamos el fork que hicimos en nuestro repositorio, tendremos una carpeta para trabajar que se llama wengy-ven.

  3. Ingresamos al directorio de la carpeta wengy-ven y ejecutamos el siguiente comando en nuestra consola:

    npm install

  4. Creamos un nuevo archivo llamado .env.

    4.1 Copiamos el contenido del archivo .env.sample al archivo nuevo que creamos: .env

  5. Creamos un bot de telegram para hacer pruebas, siguiendo los pasos acá descritos

    5.1 Al crear el bot, este nos dará un token de acceso, éste, lo utilizamos para colocarlo en el key TELEGRAM_BOT_TOKEN del archivo .env. Asimismo,colocamos tambien el nombre del bot (el que termina en bot) en el key BOT_USERNAME, nos quedaría algo así:

        TELEGRAM_BOT_TOKEN=XXXXX:XXXXX
    BOT_USERNAME=TestsBot

    5.2 Creamos un grupo en telegram, para hacer pruebas.

    5.3 Luego de crear el bot y el grupo, vamos al perfil del bot y lo agregamos al grupo de pruebas que acabamos de crear, como se indica en la siguiente imagen (En la opción "Agregar a grupo" o "Add to group"):

    Agregar bot a un grupo

  6. A partir de aquí, tendremos que obtener el groupId para configurarlo en nuestro archivo de configuración config.telegram.js, vamos a nuestro grupo y ejecutamos el siguiente comando:

    /groupId

    Y obtendremos una respuesta como la siguiente:

    Comando /groupId

    De manera que la llave mainGroupId, debería estar quedando más o menos así en el archivo de configuración config.telegram.js:

      module.exports = {
    mainGroupId: '-165387746',
    ...
  }

  7. Para correr el bot, ejecutamos: npm run start.

  8. Hacemos nuestros cambios para nuevas características y/o bugs que se encuentren en https://github.com/ngVenezuela/wengy-ven/issues

(Opcional)

Si queremos probar la integración de https://dialogflow.com, tendrás que:

  1. Crear un agente
  2. Obtener las variables de un archivo json generado siguiendo las siguientes instrucciones y colocarlo en el archivo .env en las llave DIALOGFLOW_CLIENT_EMAIL, DIALOGFLOW_PRIVATE_KEY y DIALOGFLOW_PROJECT_ID.
  3. Entrenarlo para que responda a tus pruebas

Si queremos probar los releases de los repositorios que estamos monitoreando (en la llave feeds en el archivo config.telegram.js):

  1. Registrarse en Superfeedr

  2. Creamos una subscripción por cada release del repo que deseemos monitorear (usaremos como ejemplo el repo de angular).

    2.1. En el campo topic url colocamos el feed del release de angular: https://github.com/angular/angular/releases.atom

    2.2 En el campo subscription format seleccionamos json (este es el formato en el que superfeedr convierte el feed)

    2.3 En el campo suubscription webhook url colocamos la url que nos devuelve ngrok en junto con nuestro token de telegram, y quedaría algo así: https://XXX.ngrok.io/TELEGRAM_TOKEN, y le damos clic al botón "Create" que crea la suscripción. De momento, superfeedr verifica estos feeds cada 15 minutos, para que se tome en cuenta al momento de hacer las pruebas.

Si queremos probar la integración de Github, tendrás que:

  1. Entra con tu cuenta de github a Generar un token.
  2. Cambiar el token generado por el que está en nuestro archivo .env en la llave GITHUB_ACCESS_TOKEN.
Clone this wiki locally