Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.85 KB

Self-Hosting-Guide.md

File metadata and controls

56 lines (42 loc) · 1.85 KB
Raw

Self Hosting Guide

⛵ Prerequisites

🚀 Installation

Run the following commands to clone the repo

> git clone https://github.com/AliAryanTech/Chisato-WhatsApp
> cd Chisato-WhatsApp

Run this following command to install the dependencies

> yarn install

⚠ Requirements

  • A cluster URI of the MongoDB. You can get it by following the steps given here

🔧 Configuration

Rename the file .env.example to .env and fill the missing fields

PREFIX=PREFIX_OF_THE_BOT
BOT_NAME=NAME
CHAT_BOT_URL=YOUR_API_FROM_BRAINSHOP
SESSION=YOUR_SESSION
MONGO_URI=YOUR_CLUSTER_URI
MODS=BOT_ADMINS_NUMBER (should be seperated by a comma and a space)
  • PREFIX: Prefix of the bot
  • BOT_NAME: Name of the bot
  • CHAT_BOT_URL: API key from Brainshop
  • MONGO_URI: A secret String for MongoDB connection. (Required)
  • MODS: Number of the users who should be the admins of the bot (should be in international format without "+" and multiple numbers must be separated by a comma ", ")
  • SESSION: Session of the bot

🍀 Running

> yarn start

Running the above command will start the bot. To authenticate scan the QR which shows up in the terminal or the link which is logged when the QR event fires using the WA-Web Scanner on your WhatsApp. Now you're on your own. Good Luck!

Don't want to do the hassle of setting up on your own PC?

Set it up on Heroku