diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 350f484..176cfc7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,11 +34,47 @@ Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de e yarn run cli ``` -__Seguir instrucciones__ -En la consola encontraras los pasos a seguir +Selecionas (mediante las flechas arriba y abajo) el proveedor que quieras usar y cuando estes sobre el presiona la barra de espacio, igualmente selecciona la base de datos que quieras usar. + +Se cre贸 un subdirecorio con el nombre del proveedor y base de datos que seleccionaste, ejemplo: `base-bailey-mysql` + +Dentro de ese directorio necesitas editar el archivo package.json y borrar las siguientes lineas: +``` + "@bot-whatsapp/bot": "latest", + "@bot-whatsapp/cli": "latest", + "@bot-whatsapp/database": "latest", + "@bot-whatsapp/provider": "latest", +``` + +Cambiate al directorio creado ejemplo: `base-bailey-mysql` +``` +cd base-baileys-mysql +``` +Ejecuta los comandos: +``` +npm install +npm run pre-copy +npm start +``` +En el caso de MySql y Mongo es necesario especificar en app.js los datos de la conexi贸n, ejemplo de MySql: +``` +const BaileysProvider = require('@bot-whatsapp/provider/baileys') +const MySQLAdapter = require('@bot-whatsapp/database/mysql') + +/** + * Declaramos las conexiones de MySQL + */ +const MYSQL_DB_HOST = 'localhost' +const MYSQL_DB_USER = 'usr' +const MYSQL_DB_PASSWORD = 'pass' +const MYSQL_DB_NAME = 'bot' +``` + ![](https://i.imgur.com/dC6lEwy.png) + ### 馃 Preguntas frecuentes - 驴Como puedo hacer aportaciones de c贸digo en el proyecto?: [Ver Video](https://youtu.be/Lxt8Acob6aU) - 驴Como ejecutar el entorno de pruebas?: [Ver Video](https://youtu.be/Mf9V-dloBfk) diff --git a/starters/apps/base-bailey-memory/README.md b/starters/apps/base-bailey-memory/README.md index 4d1d6b2..d0e43d2 100644 --- a/starters/apps/base-bailey-memory/README.md +++ b/starters/apps/base-bailey-memory/README.md @@ -1,14 +1,24 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-bailey-mongo/README.md b/starters/apps/base-bailey-mongo/README.md index d5a4d67..a22e43b 100644 --- a/starters/apps/base-bailey-mongo/README.md +++ b/starters/apps/base-bailey-mongo/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos: ```js // app.js @@ -16,6 +17,16 @@ const MONGO_DB_URI = 'mongodb://0.0.0.0:27017' const MONGO_DB_NAME = 'db_bot' ``` + Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + + Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-bailey-mysql/README.md b/starters/apps/base-bailey-mysql/README.md index fbad3da..4a1cab2 100644 --- a/starters/apps/base-bailey-mysql/README.md +++ b/starters/apps/base-bailey-mysql/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos ```js // app.js @@ -17,6 +18,16 @@ const MYSQL_DB_USER = 'user' const MYSQL_DB_PASSWORD = 'pass' const MYSQL_DB_NAME = 'bot' ``` +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install diff --git a/starters/apps/base-meta-memory/README.md b/starters/apps/base-meta-memory/README.md index 4d1d6b2..d0e43d2 100644 --- a/starters/apps/base-meta-memory/README.md +++ b/starters/apps/base-meta-memory/README.md @@ -1,14 +1,24 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-twilio-memory/README.md b/starters/apps/base-twilio-memory/README.md index 4d1d6b2..d0e43d2 100644 --- a/starters/apps/base-twilio-memory/README.md +++ b/starters/apps/base-twilio-memory/README.md @@ -1,14 +1,24 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-twilio-mongo/README.md b/starters/apps/base-twilio-mongo/README.md index d5a4d67..0791742 100644 --- a/starters/apps/base-twilio-mongo/README.md +++ b/starters/apps/base-twilio-mongo/README.md @@ -1,13 +1,14 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ + Recuerda configurar los parametros de conexion de la base de datos ```js // app.js @@ -16,6 +17,16 @@ const MONGO_DB_URI = 'mongodb://0.0.0.0:27017' const MONGO_DB_NAME = 'db_bot' ``` + Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + + Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-twilio-mysql/README.md b/starters/apps/base-twilio-mysql/README.md index fbad3da..ad304ee 100644 --- a/starters/apps/base-twilio-mysql/README.md +++ b/starters/apps/base-twilio-mysql/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos ```js // app.js @@ -17,6 +18,15 @@ const MYSQL_DB_USER = 'user' const MYSQL_DB_PASSWORD = 'pass' const MYSQL_DB_NAME = 'bot' ``` +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. ``` npm install diff --git a/starters/apps/base-venom-memory/README.md b/starters/apps/base-venom-memory/README.md index 4d1d6b2..d0e43d2 100644 --- a/starters/apps/base-venom-memory/README.md +++ b/starters/apps/base-venom-memory/README.md @@ -1,14 +1,24 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-venom-mongo/README.md b/starters/apps/base-venom-mongo/README.md index d5a4d67..b2bf791 100644 --- a/starters/apps/base-venom-mongo/README.md +++ b/starters/apps/base-venom-mongo/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos. ```js // app.js @@ -16,6 +17,16 @@ const MONGO_DB_URI = 'mongodb://0.0.0.0:27017' const MONGO_DB_NAME = 'db_bot' ``` + Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + + Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-venom-mysql/README.md b/starters/apps/base-venom-mysql/README.md index fbad3da..ad304ee 100644 --- a/starters/apps/base-venom-mysql/README.md +++ b/starters/apps/base-venom-mysql/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos ```js // app.js @@ -17,6 +18,15 @@ const MYSQL_DB_USER = 'user' const MYSQL_DB_PASSWORD = 'pass' const MYSQL_DB_NAME = 'bot' ``` +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. ``` npm install diff --git a/starters/apps/base-wweb-memory/README.md b/starters/apps/base-wweb-memory/README.md index 4d1d6b2..d0e43d2 100644 --- a/starters/apps/base-wweb-memory/README.md +++ b/starters/apps/base-wweb-memory/README.md @@ -1,14 +1,24 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-wweb-mongo/README.md b/starters/apps/base-wweb-mongo/README.md index d5a4d67..a22e43b 100644 --- a/starters/apps/base-wweb-mongo/README.md +++ b/starters/apps/base-wweb-mongo/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos: ```js // app.js @@ -16,6 +17,16 @@ const MONGO_DB_URI = 'mongodb://0.0.0.0:27017' const MONGO_DB_NAME = 'db_bot' ``` + Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + + Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. + ``` npm install npm start diff --git a/starters/apps/base-wweb-mysql/README.md b/starters/apps/base-wweb-mysql/README.md index fbad3da..ad304ee 100644 --- a/starters/apps/base-wweb-mysql/README.md +++ b/starters/apps/base-wweb-mysql/README.md @@ -1,14 +1,15 @@ ### CHATBOT Whatsapp -Este bot es una aplicaci贸n que puedes vincular con tu whatsapp crear flujos para automatizar tareas en tu negocio o procesos repetitivos +Este bot es una aplicaci贸n que puedes vincular con tu whatsapp y crear flujos para automatizar tareas en tu negocio o procesos repetitivos. -Este bot contiene un flujo basico en el cual una persona (cliente) escribe **"hola"** y el bot responde. +Este bot contiene un flujo b谩sico en el cual una persona (cliente) escribe **"hola"** y el bot responde: - Bienvenido a mi tienda -- Como puedo ayudarte? -- Tengo: Zapatos Bolsos etc.. +- 驴Como puedo ayudarte? +- Tengo: Zapatos, Bolsos etc.. __Iniciar__ -Recuerda configurar los parametros de conexion de la base de datos + +Recuerda configurar los parametros de conexi贸n de la base de datos ```js // app.js @@ -17,6 +18,15 @@ const MYSQL_DB_USER = 'user' const MYSQL_DB_PASSWORD = 'pass' const MYSQL_DB_NAME = 'bot' ``` +Los flujos se declaran de atr谩s para adelante, es decir que si tienes un flujo de este tipo: + + Menu Principal + - SubMenu 1 + - Submenu 1.1 + - Submenu 2 + - Submenu 2.1 + +Primero se declaran los submenus 1.1 y 2.1, luego el 1 y 2 y al final el principal. ``` npm install