-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c303d5f
commit eb0aa01
Showing
1 changed file
with
49 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,69 @@ | ||
| <p align="center"> | ||
| <img width="300" height="300" src="https://i.ibb.co/7y1v1q4/hour.png"> | ||
| </p> | ||
| <img align="right" width="250" height="250" src="https://i.ibb.co/7y1v1q4/hour.png"> | ||
|
|
||
| # SoraErlyana | ||
|
|
||
| > This project still on development 🚧, 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 ! | ||
| WhatsApp bot powered by Node.js, with several daily commands that might be useful for you | ||
|
|
||
| [](https://nodejs.org) | ||
| [](https://web.pln.co.id/tentang-kami/profil-perusahaan) | ||
| [](http://forthebadge.com) | ||
|
|
||
| # Preview | ||
|
|
||
|  | ||
|
|
||
| # Technology Used <!-- {docsify-ignore} --> | ||
| <a href='https://nodejs.org' target="_blank"><img alt='node.js' src='https://img.shields.io/badge/Node.js-100000?style=for-the-badge&logo=node.js&logoColor=white&labelColor=60AA50&color=447C42'/></a> <a href='https://www.typescriptlang.org/' target="_blank"><img alt='typescript' src='https://img.shields.io/badge/Typescript-100000?style=for-the-badge&logo=typescript&logoColor=white&labelColor=5094DD&color=5094DD'/></a> | ||
|
|
||
| > This project still on development 🚧, so it might have a massive changes, so stay tuned ! | ||
|  | ||
|  | ||
|
|
||
| # Features | ||
|
|
||
| Look at the documentation in the link down below ! Section `USAGE` ! | ||
|
|
||
| # 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 : | ||
| ``` | ||
|
|
||
| ```bash | ||
| WhatsApp terms & conditions do not allow any unofficial bots or automation on its services. | ||
| And this app is considered unofficial. | ||
| ``` | ||
| So, I do not responsible for any banning happen to your WhatsApp account by using this app. <b>I strongly suggested</b> you to use this app with your new or backup WhatsApp number. I use my second number for this and still safe until now. | ||
|
|
||
| So, I am not responsible for any banning happen to your WhatsApp account by using this app. **I strongly suggests** you to use this app with your new or backup WhatsApp number. I use my second number for this and still safe until now. | ||
|
|
||
| # Quickstart | ||
|
|
||
| The installation needs several steps, you might want to see the documentation for more information. | ||
|
|
||
| For quick installation, first thing you can clone the app, no matter what method you use, below is the simple example one : | ||
|
|
||
| ```bash | ||
| git clone https://github.com/gensart-ai/whatsapp-bot.git | ||
| ``` | ||
|
|
||
| After that, you need to install the dependencies needed for the app, by doing : | ||
|
|
||
| ```bash | ||
| npm i | ||
| ``` | ||
|
|
||
| And, since the app was developed in Typescript, you can build it by using command provided on `package.json` : | ||
|
|
||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| Or you can run directly the Typescript (for development), by using `npm run dev`. FYI, I use `tsx` for running .ts files. | ||
|
|
||
| If you have done the step above, you should see some QR code in the terminal, that's the same QR when you use WhatsApp Web for authenticating. Scan the QR using your WhatsApp app. | ||
|
|
||
| Wait for a message `System is online!`, and voila ! You are successfully integrates your WhatsApp to the app ! | ||
|
|
||
| Try to send `.help` to the WhatsApp you integrates in. It should return available commands as a response. | ||
|
|
||
| Current Stable Version : `1.1.0` | ||
| Look more at the documentation ▶ : [here](https://gensart-ai.github.io/whatsapp-bot) |