An Awesome WhatsApp Bot To Jumpstart Your Projects

WhatsApp Bot

An Awesome WhatsApp Bot To Jumpstart Your Projects!

Table Of Contents

• Table Of Contents
• About The Project
• Docker
• Deploy to Heroku
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
  • Creating A Pull Request
• License
• Authors
• Acknowledgements

About The Project

If you want an easy start on getting commands on your WhatsApp Bot. This project comes in with many in-built useful and flexible features, this is the only template project you will need

Here's why:

• Dynamic Command Handler:

  • The command handler, you don't need to indulge in main bot files to create your very own command!
  • You can simply make command groups (categorized as folders) in the commands folder.

• Dynamic Event Handler:

  • All events goes inside the controllers folder. You don't need to use socks.ev.on() in the main file to handle events.
  • Using simple skeleton code for events, you can make any amount of events in the events folder using the event handler.

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

Docker

To create a container and run Whatsapp Bot. You will need to have docker installed on your machine.

Run docker by using:

docker-composer up --build

Deploy to Heroku

You can deploy the bot to heroku by yourself using the button below:

Built With

• TypeScript 4.6.2
• @adiwajshing/Baileys 4.0.1

Getting Started

GNU/Linux Legacy: you can deploy in minimal time without any prior knowledge using this method. To run the bot on your device manually, you can use the following commands

Prerequisites

WhatsApp Account: If you don't have one, you can sign up for free

• npm

npm install npm@latest -g

• yarn

npm install yarn -g

Installation

1. Clone the repo

git clone https://github.com/Nata4n/whatsapp-bot.git

2. Installing Dependencies

yarn install

Usage

Before running the below command, make sure you're in the project directory that you've just cloned!

1. Run the WhatsApp Bot

yarn dev

You will see a QR Code printed on your terminal, scan it with WhatsApp

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the code with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Natan Rodrigues - Cyber Security student - @Nata4n

Acknowledgements

• Mr Diniz
• Introdução-de-docker-para-pentesters

(back to top)