Self-hosting-guide.md

WhatsApp-Botto-Void Self-hosting Guide

⛵ Prerequisites

• Git
• Node.JS
• WebP
• FFMpeg
• ImageMagick-Legacy

🍀 Installation

Run the following code to clone the repo

> git clone https://github.com/PrajjwalDatir/Kaoi.git
> cd Kaoi

Run this to install the depencencies

> yarn install --frozen--lockfile

✍ Configuration

Create a file named .env as per https://github.com/PrajjwalDatir/Kaoi/blob/main/.env.example

PREFIX The Prefix of the Bot
SESSION A string to keep track of your session. MODS The phone numbers of users wo you want to be the bot's Admins separated by a comma and must the numbers must be in the following format: [cc][number]. eg: 919744******
MONGO_URI is the Connection URL to your DB

To get the connection URL there are two ways

#1 Mongo Atlas and create an account
After you set up your account create a new Cluster
Then copy the connection url to your cluster (Mongo-Atlas-Guide)

#2 If you don't want to use Mongo Atlas you can install MongoDB in your system and use the URI provided in .env.example Follow the instructions here to install MongoDB in your system

⌨ Building

Run yarn run build and the Compiled JS files, Deceleration Files, Maps and Declaration Maps with their folder will appear in the dist folder

💻 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!