## Table of Contents
AutoAtende is a WhatsApp bot developed in Node.js using the Baileys library. This bot is designed to automate tasks on WhatsApp, making it a useful tool for various purposes.
Before you can run the AutoAtende WhatsApp Bot, ensure you have the following dependencies installed:
- Node.js: Download Node.js
- MariaDB: Download MariaDB
To install the AutoAtende WhatsApp Bot, follow these steps:
-
Clone this repository to your local machine:
git clone https://github.com/lucassaud/autoatende.git
-
Change your working directory to the project folder:
cd autoatende -
Install the required Node.js packages using npm:
npm install
-
Set up your MariaDB database. You may need to create a database, configure the connection settings in the
conf/config.jsfile, and run any necessary migrations. -
Start the bot:
npm start
The AutoAtende WhatsApp Bot should now be up and running.
To use the bot, you can interact with it via WhatsApp. The bot can perform various tasks depending on its configuration and your specific use case.
You can use the following commands in your WhatsApp conversations:
-
!delivery: Notifies that the order is out for delivery.
!entregaExample: Send
!entregato notify the customer that their order is out for delivery. -
!pickup: Notifies that the order is ready for pickup.
!retiradaExample: Send
!retiradato inform the customer that their order is ready for pickup. -
!block: Adds the number to the exclusion list.
!bloqueiaExample: Send
!bloqueiato add a number to the exclusion list. -
!unblock: Removes the number from the exclusion list.
!desbloqueiaExample: Send
!desbloqueiato remove a number from the exclusion list. -
!bot: Notifies the use of the bot.
!botExample: Send
!botto receive information about the bot. -
!backup: Performs a database backup.
!backupExample: Send
!backupto initiate a backup of the database. -
!status: Checks the server status.
!statusExample: Send
!statusto get information about the server status. -
!pix: Receives the company's PIX key.
!pixExample: Send
!pixto receive the company's PIX key for payment. -
!stats: Gets statistics and reports.
!statsExample: Send
!statsto retrieve statistics and reports. -
!hello: Receives a greeting from the bot.
!oiExample: Send
!oito receive a friendly greeting from the bot. -
!welcome: Receives welcome messages.
!bvExample: Send
!bvto receive welcome messages. -
!menu: Shows the menu.
!cardapioExample: Send
!cardapioto view the menu. -
!address: Shows the store's address.
!enderecoExample: Send
!enderecoto get the store's address. -
!hours: Shows the store's operating hours.
!horarioExample: Send
!horarioto check the store's operating hours.
All commands can be changed by accessing the config.js file. To make alterations, please access the config.js file.
If you would like to contribute to this project, please follow these guidelines:
-
Fork the repository on GitHub.
-
Make your changes and commit them to your fork.
-
Submit a pull request to the main repository.
-
Your contributions will be reviewed and merged if they align with the project's goals.
Hippocratic + Do Not Harm Version 1.0
This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by WA or any of its affiliates or subsidiaries. This is an independent and unofficial software. Use at your own risk.
- Author: Lucas Marinho Saud
- GitHub: https://github.com/lucassaud
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.