Skip to main content

​
Getting Started

The fastest way to get started with BuilderBot is using our CLI tool: 
npm create builderbot@latest
This interactive CLI will guide you through creating a new bot with your choice of provider and database.

​
Example Projects

BuilderBot provides a comprehensive set of starter templates combining different providers and databases. All examples are located in the starters directory.

​
WhatsApp Providers

​
Baileys (Free)

Baileys is a free, open-source WhatsApp Web API implementation:
  • base-js-baileys-memory - In-memory storage (no persistence)
  • base-js-baileys-json - JSON file storage
  • base-js-baileys-mysql - MySQL database
  • base-js-baileys-postgres - PostgreSQL database
  • base-js-baileys-mongo - MongoDB database

​
Evolution API

Evolution API provides a robust WhatsApp solution:
  • base-js-evolution-api-memory - In-memory storage
  • base-js-evolution-api-json - JSON file storage
  • base-js-evolution-api-mysql - MySQL database
  • base-js-evolution-api-postgres - PostgreSQL database
  • base-js-evolution-api-mongo - MongoDB database

​
Other Messaging Platforms

​
Email

Build email automation bots:
  • base-js-email-memory - In-memory storage
  • base-js-email-json - JSON file storage
  • base-js-email-mysql - MySQL database
  • base-js-email-postgres - PostgreSQL database
  • base-js-email-mongo - MongoDB database

​
Facebook Messenger

Create Facebook Messenger bots:
  • base-js-facebook-messenger-memory - In-memory storage
  • base-js-facebook-messenger-json - JSON file storage
  • base-js-facebook-messenger-mysql - MySQL database
  • base-js-facebook-messenger-postgres - PostgreSQL database
  • base-js-facebook-messenger-mongo - MongoDB database

​
Common Use Cases

​
Customer Support Automation

BuildBot excels at automating customer support workflows:
  • Set up automated responses for frequently asked questions
  • Create conversation flows for common support scenarios
  • Track customer interactions and conversation history
  • Integrate with your existing support systems

​
Lead Generation

Capture and qualify leads automatically:
  • Design conversation flows to collect customer information
  • Qualify leads based on responses
  • Store lead data in your preferred database
  • Integrate with CRM systems

​
Appointment Scheduling

Automate appointment booking:
  • Guide users through the booking process
  • Check availability and confirm appointments
  • Send reminders and notifications
  • Handle cancellations and rescheduling

​
E-commerce Integration

Enhance your online store:
  • Provide product information and recommendations
  • Process orders through conversations
  • Send order status updates
  • Handle customer inquiries about products

​
Notifications & Alerts

Keep users informed:
  • Send automated notifications about system events
  • Deliver personalized alerts based on user preferences
  • Provide timely updates about order status, appointments, etc.

​
TypeScript Support

All examples are available in both JavaScript and TypeScript versions. TypeScript versions provide:
  • Type safety and better IDE support
  • Enhanced code completion
  • Easier refactoring
  • Better documentation through types

​
Database Options

Choose the database that best fits your needs:
  • Memory - Great for testing and development, no persistence
  • JSON - Simple file-based storage, perfect for small projects
  • MySQL - Reliable relational database for production use
  • PostgreSQL - Advanced relational database with rich features
  • MongoDB - NoSQL database for flexible schema requirements

​
Next Steps

Quick Start

Get started with your first BuilderBot project

Documentation

Explore the full documentation

Contributing

Learn how to contribute to the project

Official Course

Take the official BuilderBot course

Build docs developers (and LLMs) love

Get started for freeTalk to us