diff --git a/README.md b/README.md index 00a9199..5efe732 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@

+ # SoraErlyana ![forthebadge](https://img.shields.io/github/last-commit/gensart-ai/whatsapp-bot/main?display_timestamp=author&style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2Fgensart-ai%2Fwhatsapp-bot) @@ -12,11 +13,13 @@ WhatsApp bot powered by Node.js, with several daily commands that might be usefu # Preview -![preview of the bot](https://i.ibb.co/0f7r1jj/0229.gif) +The preview might take a while to load sometimes, depends on your connection. + +![preview of the bot](https://i.ibb.co/BKDnYQD/whatsapp-bot-preview.gif) # Technology Used -> This project still on development 🚧, so it might have a massive changes, so stay tuned ! +> This project still on maintaining 🚧, so it might have a massive changes, so stay tuned ! ![forthebadge](https://img.shields.io/badge/Node.js-100000?style=for-the-badge&logo=node.js&logoColor=white&labelColor=60AA50&color=447C42) ![forthebadge](https://img.shields.io/badge/Typescript-100000?style=for-the-badge&logo=typescript&logoColor=white&labelColor=5094DD&color=5094DD) diff --git a/docs/README.md b/docs/README.md index 6680616..1e84e0f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -> This project still on development 🚧, so it might have a massive changes, stay tuned ! +> This project is still maintained, so it might have a massive changes, stay tuned ! #### WhatsApp bot powered by Node.js, with several daily commands that might be useful for you ! @@ -8,14 +8,18 @@ [![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.png)](https://web.pln.co.id/tentang-kami/profil-perusahaan) [![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com) -# Technology Used -node.js typescript +# Technology Used + +- NodeJS +- TypeScript +- whatsapp-web.js +- Debian # Overview -!> This application uses `whatsapp-web.js` as a primary library. Keep in mind if you want to use this app, you did already know that **WhatsApp terms & conditions do not allow any bots or automation** on its services. So, I do not responsible for any banning happen to your WhatsApp account by using this app. I strongly suggested you to use this app with your WhatsApp backup number. I use my second number for this and still safe until now. + +!> This application uses `whatsapp-web.js` as a primary library. Keep in mind if you want to use this app, you did already know that **WhatsApp terms & conditions do not allow any bots or automation** on its services. So, I do not responsible for any banning happen to your WhatsApp account by using this app. **I strongly suggest** you to use this app with your WhatsApp backup number. I use my second number for this and still safe until now. Current Stable Version : `1.1.0` -Look at the sidebar for more docs. -(Can't see the sidebar on mobile ? The button is on your bottom left screen :)) +Look at the sidebar for more docs. -And it's done. +# Can't see the sidebar on mobile ? The button is on your bottom left screen diff --git a/docs/REQUIREMENTS.md b/docs/REQUIREMENTS.md index 5ba64ed..6039fe6 100644 --- a/docs/REQUIREMENTS.md +++ b/docs/REQUIREMENTS.md @@ -1,7 +1,9 @@ -# Requirements +# Requirements + +## TL;DR -## TL;DR You need : + - Node.js v18++ - NPM installed on your device - [ffmpeg](https://ffmpeg.org/) (Windows users may need this) - For multimedia support @@ -9,12 +11,18 @@ You need : - Ghola API, learn more at [https://www.ghola.ai/developer](https://www.ghola.ai/developer). You may need to signup/login using Google account first. Its usage is for AI Text Generation ## Long to short + This project requires **Node.js** to run, I use **Node v20.10** on Windows 10 and **Debian 11** too and it works fine. I haven't tested it yet on different version or environment than mine, but you may try it and report it to me, so I can update this details by you :). -You can use this [link](https://nodejs.org/en) to go to Node.js homepage for installation or more details. +You can use this [link](https://nodejs.org/en) to go to Node.js homepage for installation or more details. -Oh also, make sure you have installed **NPM** too. Usually **Node.js** includes **NPM** so you don't need to install it again. +Oh also, make sure you have installed **NPM** too. Usually **Node.js** includes **NPM** so you don't need to install it again. And i often experience errors when testing multimedia with this app on Windows 10 environment, but not on Debian 11. My assumption going to **ffmpeg** problem, maybe you can install that if you experience an error when dealing with multimedia thing. -## **🔴 IMPORTANT NOTICE 🔴** -This project greatly having use of [whatsapp-web.js](https://wwebjs.dev/), and maybe **if you are running on a `no-gui` Linux image (Server, or Linux OS that did not installed GUI system)**, you may need to see and follow this page first : [Click Me](https://wwebjs.dev/guide/#installation-on-no-gui-systems) \ No newline at end of file +You also need ImgBB for multimedia thing in current built-in features. Soon maybe I'll explain more why I use this, and maybe doing removal on need of ImgBB if possible. See [here](https://api.imgbb.com/) for more information. + +Ghola API key is needed for built-in feature : AI with `.tanya` command. It hits Ghola's AI API. See [here](https://www.ghola.ai/developer) for more information. + +## **🔴 IMPORTANT NOTICE 🔴** + +This project greatly having use of [whatsapp-web.js](https://wwebjs.dev/), and maybe **if you are running on a `no-gui` Linux image (Server, or Linux OS that did not installed GUI system)**, you may need to see and follow this page first : [Click Me](https://wwebjs.dev/guide/#installation-on-no-gui-systems) diff --git a/docs/index.html b/docs/index.html index dbffcec..f2dd482 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,7 +22,7 @@