Start here · Quickstart
Edit this page on GitHubQuickstart
Install
Criar um bot é tão simples quanto executar o seguinte comando e seguir as instruções
pnpm create builderbot@latestUtilize a tecla espaço para seleccionar e a tecla enter para confirmar. A CLI realiza uma verificação preliminar do nó e da versão do sistema operativo, informando-o se cumpre os requisitos ou fornecendo-lhe informações relevantes. Além de gerar um projeto de base para você simplesmente iniciar
Requirements
Certifique-se de ter instalado o Node versão 20 ou superior, abaixo você pode ver um exemplo para verificar a versão do node que você está usando.
node -v
v20.10.0Recomenda-se ter o GIT instalado para uma operação adequada. Se você estiver usando Linux ou Macos, provavelmente já tem o GIT instalado por padrão.
git -v
git version XXXXBase Example
Neste exemplo, podemos ver a base de um bot simples que responde às palavras-chave enviadas por um usuário, as palavras são: info, hello, hi. Você pode ver como criar o bot e implementar o 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.