mirror of
https://github.com/cheveguerra/bot-whatsapp.git
synced 2026-04-18 19:49:16 +00:00
docs: ⚡ more info
This commit is contained in:
Leifer Mendez
3
packages/docs/src/routes/docs/custom/index.mdx
Normal file
3
packages/docs/src/routes/docs/custom/index.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
# Extender Funcionalidades
|
||||
|
||||
...
|
||||
32
packages/docs/src/routes/docs/database/index.mdx
Normal file
32
packages/docs/src/routes/docs/database/index.mdx
Normal file
@@ -0,0 +1,32 @@
|
||||
import Alert from '../../../components/widgets/Alert'
|
||||
|
||||
# DataBase (Base de datos)
|
||||
|
||||
<Alert>
|
||||
⚡ Dependiendo del tipo de conector que utlices puede que necesites pasar
|
||||
algunas configuracion adicional como **user, host, password** para esos
|
||||
casos te recomendamos guiarte de los
|
||||
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)**
|
||||
o si gustas puedes editar esta documentación para ir agregando más info
|
||||
</Alert>
|
||||
|
||||
Es la pieza encargada de mantener el **"estado"** de una conversación, para mayor facilidad la libreria te proporcia diferentes conectores que se de adapten mejor a tu desarrollo
|
||||
|
||||
```js
|
||||
const MongoAdapter = require('@bot-whatsapp/database/mongo')
|
||||
....
|
||||
const adapterDB = new MongoAdapter({
|
||||
dbUri: 'mongodb://0.0.0.0:27017',
|
||||
dbName: 'db_bot',
|
||||
})
|
||||
```
|
||||
|
||||
Los conectores disponibles hasta el momento son los siguientes:
|
||||
|
||||
`require('@bot-whatsapp/database/mock')`
|
||||
|
||||
`require('@bot-whatsapp/database/mongo')`
|
||||
|
||||
`require('@bot-whatsapp/database/mysql')`
|
||||
|
||||
`require('@bot-whatsapp/database/json')`
|
||||
@@ -1,6 +1,14 @@
|
||||
import Alert from '../../../components/widgets/Alert'
|
||||
|
||||
# Conceptos
|
||||
|
||||
Durante el desarrollo de este sistema se elaboraron tres (3) conceptos principales que conformar el funcionamiento
|
||||
El desarrollo de la librería se base en tres (3) piezas claves para su correcto funcionamiento:
|
||||
|
||||
- **Flow:** Encargado de construir todo el contexto de la conversación, finalmente su objetivo es brindar una capa amigable al desarrollador.
|
||||
- **Provider:** Como si de un [conector](https://www.dignited.com/wp-content/uploads/2019/06/Plug-type-768x432.jpg) se tratara el objetivo es poder cambiar facilmente de proveedor de Whatsapp en minutos
|
||||
sin el riesgo de dañar otras partes del bot
|
||||
- **Database:** Siguiendo la linea de pensamiento de conectores, de igual manera que el provider nos brinda la capacidad de poder cambiar de capa de persistencia de datos (guardar datos) sin invertir tiempo en
|
||||
reescribir nuestro flujo.
|
||||
|
||||
---
|
||||
|
||||
@@ -29,6 +37,14 @@ const flowPrincipal = addKeyword(['hola', 'alo'])
|
||||
|
||||
## Provider (Proveedor)
|
||||
|
||||
<Alert>
|
||||
⚡ Dependiendo del tipo de proveedor que utlices puede que necesites pasar
|
||||
algunas configuracion adicional como **token, api, etc.** para esos casos te
|
||||
recomendamos guiarte de los
|
||||
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)**
|
||||
o si gustas puedes editar esta documentación para ir agregando más info
|
||||
</Alert>
|
||||
|
||||
Es la pieza que conectara tu flujo con Whatsapp. En este chatbot tenemos varios proveedores disponibles la mayoria gratis pero tambien tenemos integracion la api oficial de whatsapp o twilio
|
||||
|
||||
```js
|
||||
@@ -39,26 +55,45 @@ const adapterProvider = createProvider(WhatsappProvider)
|
||||
|
||||
Los proveedores disponibles hasta el momento son los siguientes:
|
||||
|
||||
### [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js)
|
||||
[whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) `require('@bot-whatsapp/provider/web-whatsapp')`
|
||||
|
||||
**require('@bot-whatsapp/provider/web-whatsapp')**
|
||||
[Venom](https://github.com/orkestral/venom) `require('@bot-whatsapp/provider/venom')`
|
||||
|
||||
### [Venom](https://github.com/orkestral/venom)
|
||||
[Baileys](https://github.com/adiwajshing/Baileys) `require('@bot-whatsapp/provider/baileys')`
|
||||
|
||||
**require('@bot-whatsapp/provider/venom')**
|
||||
[Meta Official](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages) `require('@bot-whatsapp/provider/meta')`
|
||||
|
||||
### [Baileys](https://github.com/adiwajshing/Baileys)
|
||||
|
||||
**require('@bot-whatsapp/provider/baileys')**
|
||||
|
||||
### [Meta Official](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages)
|
||||
|
||||
**require('@bot-whatsapp/provider/meta')**
|
||||
|
||||
### [Twilio Official](https://www.twilio.com/es-mx/messaging/whatsapp)
|
||||
|
||||
**require('@bot-whatsapp/provider/twilio')**
|
||||
[Twilio Official](https://www.twilio.com/es-mx/messaging/whatsapp) `require('@bot-whatsapp/provider/twilio')`
|
||||
|
||||
---
|
||||
|
||||
## DataBase (Base de datos)
|
||||
|
||||
<Alert>
|
||||
⚡ Dependiendo del tipo de conector que utlices puede que necesites pasar
|
||||
algunas configuracion adicional como **user, host, password** para esos
|
||||
casos te recomendamos guiarte de los
|
||||
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)**
|
||||
o si gustas puedes editar esta documentación para ir agregando más info
|
||||
</Alert>
|
||||
|
||||
Es la pieza encargada de mantener el **"estado"** de una conversación, para mayor facilidad la libreria te proporcia diferentes conectores que se de adapten mejor a tu desarrollo
|
||||
|
||||
```js
|
||||
const MongoAdapter = require('@bot-whatsapp/database/mongo')
|
||||
....
|
||||
const adapterDB = new MongoAdapter({
|
||||
dbUri: 'mongodb://0.0.0.0:27017',
|
||||
dbName: 'db_bot',
|
||||
})
|
||||
```
|
||||
|
||||
Los conectores disponibles hasta el momento son los siguientes:
|
||||
|
||||
`require('@bot-whatsapp/database/mock')`
|
||||
|
||||
`require('@bot-whatsapp/database/mongo')`
|
||||
|
||||
`require('@bot-whatsapp/database/mysql')`
|
||||
|
||||
`require('@bot-whatsapp/database/json')`
|
||||
|
||||
20
packages/docs/src/routes/docs/flows/index.mdx
Normal file
20
packages/docs/src/routes/docs/flows/index.mdx
Normal file
@@ -0,0 +1,20 @@
|
||||
# Flow (Flujos)
|
||||
|
||||
Los flujos hace referencia al hecho de construir un flujo de conversion. Esto es un flow podemos observar que estan presente dos metodos importantes **addKeyword** y el **addAnswer**.
|
||||
|
||||
Tan sencillo como decir **palabra/s clave** y **mensaje a responder**
|
||||
|
||||
Ambos metodos **[addKeyword](https://github.com/codigoencasa/bot-whatsapp/blob/dev/packages/bot/io/methods/addKeyword.js)** y el **[addAnswer](https://github.com/codigoencasa/bot-whatsapp/blob/dev/packages/bot/io/methods/addAnswer.js)** tienen una serie opciones disponibles
|
||||
|
||||
```js
|
||||
const {
|
||||
createBot,
|
||||
createProvider,
|
||||
createFlow,
|
||||
addKeyword,
|
||||
} = require('@bot-whatsapp/bot')
|
||||
|
||||
const flowPrincipal = addKeyword(['hola', 'alo'])
|
||||
.addAnswer(['Hola, bienvenido a mi tienda', '¿Como puedo ayudarte?'])
|
||||
.addAnswer(['Tengo:', 'Zapatos', 'Bolsos', 'etc ...'])
|
||||
```
|
||||
@@ -11,7 +11,7 @@ import Alert from '../../components/widgets/Alert'
|
||||
|
||||
## ¿Que es esto?
|
||||
|
||||
Esto es una librería que te permitirá **crear chatbot para WhatsApp** en tan solo minutos de una manera ágil y rápida. A lo largo de esta documentación encontrarás ejemplos y material de ayuda.
|
||||
**@bot-whatsapp** es una librería que te permitirá **crear chatbot para WhatsApp** en tan solo minutos de una manera ágil y rápida. A lo largo de esta documentación encontrarás ejemplos y material de ayuda.
|
||||
|
||||
Si eres una persona con **poco tiempo y gran capacidad** de comprensión con conocimientos, ejecutando proyectos en Node.js y manejo de terminal.
|
||||
Esta documentación te ayudará a instalar tu bot de WhatsApp en simples pasos con el propósito de que tengas un chatbot funcional **en solo minutos.**
|
||||
|
||||
3
packages/docs/src/routes/docs/join/index.mdx
Normal file
3
packages/docs/src/routes/docs/join/index.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
# Unirme
|
||||
|
||||
...
|
||||
@@ -1,8 +1,10 @@
|
||||
import { component$, Slot, useContext } from '@builder.io/qwik'
|
||||
import type { DocumentHead } from '@builder.io/qwik-city'
|
||||
import ExtraBar from '~/components/widgets/ExtraBar'
|
||||
import Footer from '~/components/widgets/Footer'
|
||||
import Header from '~/components/widgets/Header'
|
||||
import NavBar from '~/components/widgets/NavBar'
|
||||
import SponsorBar from '~/components/widgets/SponsorBar'
|
||||
import { GlobalStore } from '~/contexts'
|
||||
// import Navigation from '~/components/widgets/Navigation'
|
||||
// import Collaborators from '~/components/widgets/Collaborators'
|
||||
@@ -37,7 +39,8 @@ export default component$(() => {
|
||||
'hidden lg:block fixed z-20 inset-0 top-[4rem] right-[max(0px,calc(50%-48rem))] left-auto w-[14.5rem] py-5 px-8 overflow-y-auto'
|
||||
}
|
||||
>
|
||||
<NavBar options={store} />
|
||||
<ExtraBar />
|
||||
<SponsorBar />
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
31
packages/docs/src/routes/docs/providers/index.mdx
Normal file
31
packages/docs/src/routes/docs/providers/index.mdx
Normal file
@@ -0,0 +1,31 @@
|
||||
import Alert from '../../../components/widgets/Alert'
|
||||
|
||||
# Provider (Proveedor)
|
||||
|
||||
<Alert>
|
||||
⚡ Dependiendo del tipo de proveedor que utlices puede que necesites pasar
|
||||
algunas configuracion adicional como **token, api, etc.** para esos casos te
|
||||
recomendamos guiarte de los
|
||||
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)**
|
||||
o si gustas puedes editar esta documentación para ir agregando más info
|
||||
</Alert>
|
||||
|
||||
Es la pieza que conectara tu flujo con Whatsapp. En este chatbot tenemos varios proveedores disponibles la mayoria gratis pero tambien tenemos integracion la api oficial de whatsapp o twilio
|
||||
|
||||
```js
|
||||
const WhatsappProvider = require('@bot-whatsapp/provider/web-whatsapp')
|
||||
....
|
||||
const adapterProvider = createProvider(WhatsappProvider)
|
||||
```
|
||||
|
||||
Los proveedores disponibles hasta el momento son los siguientes:
|
||||
|
||||
[whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) `require('@bot-whatsapp/provider/web-whatsapp')`
|
||||
|
||||
[Venom](https://github.com/orkestral/venom) `require('@bot-whatsapp/provider/venom')`
|
||||
|
||||
[Baileys](https://github.com/adiwajshing/Baileys) `require('@bot-whatsapp/provider/baileys')`
|
||||
|
||||
[Meta Official](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages) `require('@bot-whatsapp/provider/meta')`
|
||||
|
||||
[Twilio Official](https://www.twilio.com/es-mx/messaging/whatsapp) `require('@bot-whatsapp/provider/twilio')`
|
||||
3
packages/docs/src/routes/docs/sponsors/index.mdx
Normal file
3
packages/docs/src/routes/docs/sponsors/index.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
# Sponsors
|
||||
|
||||
...
|
||||
Reference in New Issue
Block a user