# **The Coding Family: WhatsApp Bot 🤹 **
[![CodeFactor](https://www.codefactor.io/repository/github/prajjwaldatir/kaoi/badge)](https://www.codefactor.io/repository/github/prajjwaldatir/kaoi)
## [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://chat.whatsapp.com/FUKwD5I2nJC9TOgqxd1RiP) [![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![NodeJs](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/en/)
> A Fully Modular and Efficient Bot
Button : If you are deploying normally
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/the-great-M-D/Kaoi/blob/main)
Button : If you are deploying from a fork
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
Button : If you are deploying and using Railway
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FPrajjwalDatir%2FKaoi%2F&envs=PREFIX%2CSESSION%2CMODS%2CCRON%2CMONGO_URI%2CGOOGLE_API_KEY%2CCHAT_BOT_URL&optionalEnvs=MODS%2CCRON%2CGOOGLE_API_KEY%2CCHAT_BOT_URL&PREFIXDesc=Prefix+of+your+bot&SESSIONDesc=A+string+for+the+session+to+be+classified+and+to+get+access+to+the+server+endpoints&MODSDesc=The+phone+numbers+of+the+users+who+you+want+to+be+admin+for+the+bot+%28should+be+in+international+format+without+%2B+and+multiple+numbers+must+be+separated+by+a+comma+%5C%22%2C%5C%22%29&CRONDesc=Cron+string+to+clear+chats+in+a+cycle&MONGO_URIDesc=A+secret+String+for+Mongodb+Connection+%28Required%29&GOOGLE_API_KEYDesc=Google+API+key+for+Google+searches+for+MODS+%28Not+Required%29&CHAT_BOT_URLDesc=BrainShop+API+Brain+url)
Use any one of the above to deploy
## ✨ Highlights
- Fully Modular Design
- Object Oriented
- Written in [TypeScript](https://www.typescriptlang.org/)
- Self-Restoring Auth
- Built with [Baileys](https://github.com/adiwajshing/baileys) (The Best
WhatsApp Library Out There)
## 💻 Deploy/Hosting Guide
- Section Moved to
[Kaoi-Guides](https://github.com/Hiroto77/Kaoi-Guides/blob/main/README.md)
## 🍥 Features of the Repo
- To view all features, click
here➡️[M-D_featuresList.md](https://github.com/the-great-M-D/Kaoi/blob/main/Features.md)
## 🤹 Contribution
- Feel free to open issues regarding any problems or if you have any feature
requests
- Make sure to follow the ESLint Rules while editing the code and run
`yarn run prettier-format` before opening PRs
## 🤝 Contributors
- the-great-M-D
### 🟢 WhatsApp Support Group
# [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://chat.whatsapp.com/FUKwD5I2nJC9TOgqxd1RiP)
## 📄 License
Distributed under the GNU AFFERO GENERAL PUBLIC License. See [LICENSE](/LICENSE)
for more information.