Skip to content
/ ww-bot Public

A starter template for creating a Whatsapp Bot application and instructions on how to deploy it.

License

Notifications You must be signed in to change notification settings

ameybh/ww-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ww-bot

Boilerplate code for whatsapp-web.js library.

Installation

Use the package manager npm to setup ww-bot.

  1. Clone the repository.
git clone https://github.com/ameybhavsar24/ww-bot.git
  1. Install dependencies.
npm i

Currently, the project uses 2 direct dependencies which account for about 400 MB.

"dependencies": {
  "qrcode-terminal": "^0.12.0",
  "whatsapp-web.js": "^1.11.0"
}

Usage

Start the project locally.

npm start

Open Whatsapp Web QR Scanner on your phone and scan the QR code shown in terminal.

Note: The bot will stop when the process is terminated. To deploy the bot, see DEPLOY.md

You will need to authenticate everytime you start the bot unless you store a session file. You can store the session locally by creating a .env file and setting a environment variable WW_SESSION to the session string printed in the terminal.

If you are deploying the bot to Heroku, you can store the session object as WW_SESSION to Heroku configs to skip authentication. Read more in DEPLOY.md

License

ISC

About

A starter template for creating a Whatsapp Bot application and instructions on how to deploy it.

Topics

Resources

License

Stars

Watchers

Forks