Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Awesome-Tofu/miko-bot?tab=readme-ov-file
Miko bot is a feature-rich WhatsApp bot powered by whatsapp-web.js, automating tasks and providing utilities for an enhanced messaging experience. Simplify your interactions with Miko's user-friendly commands and customizable settings.
https://github.com/Awesome-Tofu/miko-bot?tab=readme-ov-file
List: miko-bot?tab=readme-ov-file
chatbot nodejs whatsapp-automation whatsapp-bot whatsapp-web-js
Last synced: 3 months ago
JSON representation
Miko bot is a feature-rich WhatsApp bot powered by whatsapp-web.js, automating tasks and providing utilities for an enhanced messaging experience. Simplify your interactions with Miko's user-friendly commands and customizable settings.
- Host: GitHub
- URL: https://github.com/Awesome-Tofu/miko-bot?tab=readme-ov-file
- Owner: Awesome-Tofu
- Created: 2023-11-04T16:37:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T13:16:14.000Z (8 months ago)
- Last Synced: 2024-05-22T14:33:39.027Z (8 months ago)
- Topics: chatbot, nodejs, whatsapp-automation, whatsapp-bot, whatsapp-web-js
- Language: JavaScript
- Homepage:
- Size: 96.1 MB
- Stars: 9
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MIKO BOT
MIKO BOT is a Node.js-based WhatsApp chatbot powered by [Puppeteer](https://pptr.dev/) and [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js). It allows you to automate interactions with WhatsApp Web, enabling various automated tasks and responses.
## Features
- **WhatsApp Automation**: MIKO BOT can automate tasks such as sending messages, images, and stickers to WhatsApp contacts or groups.
- **Dynamic Responses**: Customize your bot to provide dynamic responses based on user inputs or predefined conditions.
- **Message Handling**: Handle incoming messages, process them, and respond accordingly.
- **Sticker Handling**: Convert and create sticker with bot.
- **Chatbot AI**: Customize AI replies from the bot.
- **More?**: Just try example bot and you can explore all features.
- **Example Bot**: [Miko Bot](https://github.com/Awesome-Tofu/miko-bot?tab=readme-ov-file#getting-started) I wont be running the bot from now on, but you can try the repo
## Getting Started
Follow these steps to set up and run the MIKO BOT on your local machine or deploy it to a cloud platform like Heroku.
1. **Clone the Repository**:
```bash
git clone https://github.com/awesome-tofu/miko-bot.git
2. **Change the Directory**:
```bash
cd miko-bot
3. **Install Dependencies:**
```bash
npm install
4. **Set Environment Variables:**
**sample:** [sample.env](https://github.com/Awesome-Tofu/miko-bot/blob/main/sample.env)
```env
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD (required), if you are running on windows remove it
PUPPETEER_EXECUTABLE_PATH (required), if you are running on windows remove it
MONGODB_URI (required) (get it from https://cloud.mongodb.com/)
DEFAULT_LANGUAGE (optional)
BOT_NUMBER (required)
OWNER_NUMBER (required)
NUMVERIFY_KEY (optional)
CHATBOT (optional) (set default chatbot true/false)
INSTALLATION_ID (optional) (get truecaller installation ID from https://replit.com/@E-Venture/truecaller-installation-id?v=1)
STICKER_NAME = tofu (optional) (sticker name of .sticker command)
AUTHOR_NAME = miko (optional) (pack/author name of .sticker command)
5. **Start the script:**
```bash
npm start
6. **Scanning the QR code:**
Open the link provided by the deployment platform OR if you are running on local platform open http://localhost:3000/
7. **Command Usage:**
Once the bot is running, you can start sending commands and messages to it via WhatsApp.
| Command | Description |
| ----------------- | -------------------------------------------- |
| `.start` | Command to start the bot. |
| `.eval` | Evaluate nodejs script with vim. |
| `.sticker` | Send a sticker from replied image. |
| `.translate ` | Translate text to the default language. |
| `.report `| Report an issue with the bot. |
| `.support` | Get support and assistance. |
| `.help` | You can see more command lists |
## Support
Need any help? Feel free to join our support group. We will be happy to help you☺️
## Thanks to
- [Whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) for providing awesome package
- [WhatsBot](https://github.com/tuhinpal/WhatsBot) for telegraph, sticker, term and carbon command inspiration
- [ThiruXD ♡︎](https://github.com/ThiruXD) for making youtube downloader commands
- Last but Not Least: [You](https://i.imgur.com/lDjxY1D.gif) 
for using my repo
## Things I want you to know
I am still learning nodejs, so my code might look repeating cuz I dont want to touch code if its working, and I am having trouble in saving session on heroku. If you can help, please feel free to contribute.
## License
[MIT](https://choosealicense.com/licenses/mit/)