diff --git a/README.md b/README.md index f6f7833..5ca1d3f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ ## Chatbot Whatsapp (OpenSource) #### Actualizado Enero 2022 -El siguiente proyecto se realizó con fines educativos para el canal de [Youtube (Leifer Mendez)](https://www.youtube.com/channel/UCgrIGp5QAnC0J8LfNJxDRDw?sub_confirmation=1) donde aprendemos como usando node.js podemos crear un chatbot increíble que además le agregamos inteligencia artificial gracias al servicio de dialogflow. +El siguiente proyecto se realizó con fines educativos para el canal de [Youtube (Leifer Mendez)](https://www.youtube.com/channel/UCgrIGp5QAnC0J8LfNJxDRDw?sub_confirmation=1) donde aprendemos a crear y implementar un chatbot increíble usando [node.js](https://codigoencasa.com/tag/nodejs/) además le agregamos inteligencia artificial gracias al servicio de __dialogflow__. ![](https://i.giphy.com/media/OBDi3CXC83WkNeLEZP/giphy.webp) -> Si tienes una cuenta en __heroku__ puedes desplegar este proyecto con 1 click + +#### Acceso rápido +> Si tienes una cuenta en __heroku__ puedes desplegar este proyecto con (1 click) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/leifermendez/bot-ventas) @@ -12,47 +14,26 @@ El siguiente proyecto se realizó con fines educativos para el canal de [Youtube [![Comprar](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/leifermendez) -#### Requisitos +## Requisitos - node v14 o superior +- VSCode (Editor de codigo) [Descargar](https://code.visualstudio.com/download) +- MySql (opcional) solo aplica si vas a usar el modo 'mysql' [sql-bot.sql migración](https://github.com/leifermendez/bot-whatsapp/blob/main/sql-bot.sql) +- Dialogflow (opcional) solo aplica si vas a usar el modo 'dialogflow' -#### Video Creación 🤖 -- [Ver Video 1](https://www.youtube.com/watch?v=A_Xu0OR_HkE) -- [¿Como instalarlo? (Actulización)](https://youtu.be/5lEMCeWEJ8o) - -#### ¿Que puedo hacer con este chatbot? - -Puedes crear tus flujos de trabajo, ya sea usando mysql, dialogflow o simplemente condiciones en el codigo. -IMAGE - -### Instruciones +## Instruciones __Descargar o Clonar repositorio__ ![](https://i.imgur.com/dSpUbFz.png) -__Instalar paquetes (npm install)__ +__Instalar dependencias (npm install)__ > Ubicate en le directorio que descargaste y via consola o terminal ejecuta el siguiente comando `npm install` ![](https://i.imgur.com/BJuMjGR.png) -__Ejecutar el script app.js__ -> Ubicate en le directorio que descargaste y via consola o terminal ejecuta el siguiente comando `node app.js` o `npm start`. -Escanea el el código QR desde tu aplicación de Whatsapp -`npm run start` - -![](https://i.imgur.com/eMkBkuJ.png) - -> Ahora abre la aplicación de Whatsapp en tu dispositivo y escanea el código QR - - -> Tambien puedes visitar la pagina `http://localhost:3000/qr` -![](https://i.imgur.com/Q3JEDlP.png) - -> Cuando sale este mensaje tu BOT está __listo__ para trabajar! -![](https://i.imgur.com/bhYHUyH.png) - -### Configurar -Recuerda debes de crear tu archivo __.env__ basado en el archivo __.env.example__ +__Configurar .env__ +> Con el editor de texto crea un archivo `.env` el cual debes de guiarte del archivo `.env.example` +[Ver video explicando](https://youtu.be/5lEMCeWEJ8o?t=381) ``` ######DATABASE: none, mysql, dialogflow @@ -67,9 +48,31 @@ SQL_PASS= SQL_DATABASE= ``` -> Si quieres usar la conexion via _mysql_ puedes importar el archivo [sql-bot.sql](https://github.com/leifermendez/bot-whatsapp/blob/main/sql-bot.sql) +![](https://i.imgur.com/9poNnW0.png) -### ¿Como usarlo el chatbot de whatsapp? +__Ejecutar el script__ +> Ubicate en le directorio que descargaste y via consola o terminal ejecuta el siguiente comando +`npm run start` + +![](https://i.imgur.com/eMkBkuJ.png) + +__Whatsapp en tu celular__ +> Ahora abre la aplicación de Whatsapp en tu dispositivo y escanea el código QR + +Visitar la pagina +`http://localhost:3000/qr` + +![](https://i.imgur.com/Q3JEDlP.png) + +__Listo 😎__ +> Cuando sale este mensaje tu BOT está __listo__ para trabajar! +![](https://i.imgur.com/eoJ4Ruk.png) + +# ¿Quieres ver como se creó? 🤖 +- [Ver Video 1](https://www.youtube.com/watch?v=A_Xu0OR_HkE) +- [¿Como instalarlo? (Actulización)](https://youtu.be/5lEMCeWEJ8o) + +## ¿Como usarlo el chatbot de whatsapp? > Escribe un mensaje al whatsapp que vinculaste con tu BOT ![](https://i.imgur.com/OSUgljQ.png) @@ -80,7 +83,7 @@ con el historial de conversación con el número de tu cliente ![](https://i.imgur.com/lrMLgR8.png) ![](https://i.imgur.com/UYcoUSV.png) -### Preguntar al BOT +## Preguntar al BOT > Puedes interactuar con el bot ejemplo escribele __hola__ y el bot debe responderte! ![](https://i.imgur.com/cNAS51I.png)