Start here · Quickstart

Edit this page on GitHub

Quickstart

Install

Crear un bot es tan sencillo como ejecutar el siguiente comando y seguir las instrucciones

Requisitos previos a considerar antes de usar esta herramienta, Node v20 o superior Git

pnpm create builderbot@latest

Use la tecla espacio para seleccionar y la tecla intro para confirmar. La CLI realiza una verificación preliminar del nodo y la versión del sistema operativo, informándole si cumple con los requisitos o proporcionándole información relevante. Además de generar un proyecto base para que simplemente lo pongas en marcha

MSYS:/e/Projects
Leifer Mendez@LeiferPC MSYS /e/Projects
$ ▍

Requirements

Asegúrese de tener instalada la versión 20 o superior del nodo, a continuación puede ver un ejemplo para verificar la versión del nodo que está utilizando.

node -v
v20.10.0

Se recomienda tener GIT instalado para un correcto funcionamiento. Si está utilizando Linux o MacOc, probablemente ya tenga GIT instalado de forma predeterminada.

git -v
git version XXXX

Base Example

En este ejemplo podemos ver la base de un bot simple que responde a las palabras clave enviadas por un usuario, las palabras son ` 'info, hola, hola'. Puedes ver cómo crear el bot e implementar el flows.

import { createBot, createProvider, createFlow, addKeyword, MemoryDB } from '@builderbot/bot'
import { BaileysProvider } from '@builderbot/provider-baileys'

/** send static messages */
const welcomeFlow = addKeyword<BaileysProvider, MemoryDB>(['hello', 'hi']).addAnswer('Ey! welcome')

/** send dynamic message from db or other sources */
const infoFlow = addKeyword<BaileysProvider, MemoryDB>('info')
    .addAction(async (ctx, { flowDynamic }) => {
        await flowDynamic(`Welcome ${ctx.name}`)
    })

/** send media files */
const mediaFlow = addKeyword<BaileysProvider, MemoryDB>('image')
    .addAnswer(`Send Image A`, { media: 'https://i.imgur.com/AsvWfUX.png' })
    .addAction(async (ctx, { flowDynamic }) => {
        await flowDynamic(`Welcome ${ctx.name}`)
        await flowDynamic(
            [
                {
                    body: 'Send Image B',
                    media: 'https://i.imgur.com/w0RtKnN.png'
                }
            ]
        )
    })

/** initialization bot */
const main = async () => {

    const adapterDB = new MemoryDB()
    const adapterFlow = createFlow([welcomeFlow, infoFlow, mediaFlow])
    const adapterProvider = createProvider(BaileysProvider)

    adapterProvider.initHttpServer(3000)

    await createBot({
        flow: adapterFlow,
        provider: adapterProvider,
        database: adapterDB,
    })
}

main()

Resources

Modularize

Learn how to modularise flows so that you can have a more maintainable bot.

Send Message

How to send a message via HTTP to start conversations, you can send multimedia as well.

Dockerizer

A good practice is to dockerise your bots to make them more maintainable and effective.

Events

Learning about events will make us more fluent when creating chatbots.