Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/totigm/whatsapp-bot
This is a library to create WhatsApp bots. It handles all the commands stuff behind the scenes, so you can focus on your bot's logic.
https://github.com/totigm/whatsapp-bot
bot bot-builder botbuilder bots typescript whatsapp whatsapp-bot whatsapp-js whatsapp-web
Last synced: 29 days ago
JSON representation
This is a library to create WhatsApp bots. It handles all the commands stuff behind the scenes, so you can focus on your bot's logic.
- Host: GitHub
- URL: https://github.com/totigm/whatsapp-bot
- Owner: totigm
- License: mit
- Created: 2022-06-23T06:41:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T09:46:07.000Z (8 months ago)
- Last Synced: 2024-10-12T12:35:07.660Z (about 1 month ago)
- Topics: bot, bot-builder, botbuilder, bots, typescript, whatsapp, whatsapp-bot, whatsapp-js, whatsapp-web
- Language: TypeScript
- Homepage:
- Size: 507 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Welcome to @totigm/whatsapp-bot 👋
## 📄 Introduction
This is a library to create WhatsApp bots. It is a WhatsApp implementation of the [@totigm/bot-builder](https://www.npmjs.com/package/@totigm/bot-builder) package, which handles all the commands stuff behind the scenes, so you can focus on your bot's logic.
> The [whatsapp-web.js](https://wwebjs.dev) library is used for this implementation.
## 🔗 Quick links
- [Reference documentation](./docs/reference.md)
- [Options](#⚙️-options)
- [Whatsapp-web.js docs](https://wwebjs.dev/guide)
- [Bot builder](https://www.npmjs.com/package/@totigm/bot-builder)
- [Discord bot](https://www.npmjs.com/package/@totigm/discord-bot)
- [GitHub](https://github.com/totigm/whatsapp-bot#readme)
- [NPM](https://www.npmjs.com/package/@totigm/whatsapp-bot)
## 💻 Installation
```sh
npm i @totigm/whatsapp-bot
```
or
```sh
yarn add @totigm/whatsapp-bot
```
## 🚀 Getting started
You can use this [WhatsApp bot template](https://github.com/totigm/whatsapp-bot-template) to [generate your own](https://github.com/totigm/whatsapp-bot-template/generate). This template has everything set up for you, so you can start coding your bot right away.\
The template has TypeScript, Docker, ESLint, and Prettier already configured, so you have a nice developer experience and a production-ready bot.
Start adding commands to your bot by checking the [reference documentation](./docs/reference.md).
> The [WhatsApp bot template](https://github.com/totigm/whatsapp-bot-template) and [bot examples](#-bot-examples) are also a good reference on how to use this library.
## 🤖 Example usage
```ts
import WhatsappBot from "@totigm/whatsapp-bot";
const bot = new WhatsappBot();
bot.addCommand(
"hey",
async (message, client) => {
const chatId = message.from;
const contact = await client.getContactById(chatId);
return `Hey ${contact.pushname}! How are you doing?`;
},
{
description: "Say hey",
explanation: "The bot will say hey to the user using their WhatsApp's name",
example: {
output: "Hey Toti! How are you doing?",
},
},
);
```
The previous code will create a bot that works like this:
## 🤩 Bot examples
- [WhatsApp stickers bot](https://github.com/totigm/whatsapp-stickers-bot): WhatsApp bot that converts images and videos to stickers.
## ⚙️ Options
When you create a bot, you can pass an options object to customize it. Check its [options](./docs/options.md) documentation for more information.
```ts
const options = { ... };
const bot = new WhatsappBot(options);
```
## 🚀 Deploying
To deploy your WhatsApp bot, check out [this template](https://github.com/totigm/whatsapp-bot-template), which creates a [Docker](https://www.docker.com) image with everything needed for the [whatsapp-web.js](https://wwebjs.dev) library to work. This will help you to deploy your bot to the cloud provider of your choice.
This library automatically checks if the app is being run on a [Docker](https://www.docker.com) container and set its configurations according to that, so you don't have to worry about it.
## 👤 Author
## 🤝 Contributing
Contributions are more than welcome!
We think that you might have great ideas to make this project even better. If you do, please create a pull request and/or issue following the [contribution guidelines](./docs/CONTRIBUTING.md).
## ⭐️ Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2022 [Toti Muñoz](https://github.com/totigm).
This project is [MIT](https://github.com/totigm/whatsapp-bot/blob/master/LICENSE) licensed.
---
This project was made with ❤ and TypeScript