Skip to content

A fast, lightweight WhatsApp bot powered Baileys Web API

License

Notifications You must be signed in to change notification settings

oisaimrane111/Xstro

 
 

Repository files navigation

xstro-md: Simple WhatsApp Bot

xstro-md is an open-source WhatsApp bot designed and developed by AstroX11 to simplify WhatsApp management. Initially a private endeavor for honing JavaScript, it grew with community contributions over time. (Here's to a sponsor one day!)

Important

You can adapt the source under the terms of the included license, but I disclaim any and all liability for any misuse of this software. It is for educational purposes only—please use it responsibly.

npm
Forks
Stars

Fork Repository
Get Session
Join WhatsApp Support Group

Table of Contents

Custom Session Configuration

  1. Install Node.js

  2. Install Git

  3. Verify your Node.js installation:

    node -v
  4. Create a new directory, navigate to it in your terminal, and follow these steps:

Deployments

Heroku Deploy

  1. Click Deploy Now.
  2. Enter the required variables: SESSION_ID, BOT_INFO, SUDO, STICKER_PACK, WARN_COUNT, and TIME_ZONE.
  3. Click Deploy to begin deploying the bot.
  4. Watch Video Tutorial

Koyeb Deploy

  1. Click Deploy Now.
  2. Provide the necessary variables.
  3. Click Deploy (leave default settings in place).
  4. Watch Video Tutorial

Render Deploy

  1. Click Deploy Now.
  2. Enter the required variables: SESSION_ID, BOT_INFO, SUDO, STICKER_PACK, WARN_COUNT, and TIME_ZONE.
  3. Click Deploy Blueprint and wait for the bot to start.
  4. Copy the deployed URL.
  5. To ensure uptime, set up a monitor using Better Stack:
  6. In Better Stack, create a monitor with your deployed URL (pings every 5 minutes).
  7. Watch Video Tutorial

Panel Deploy

Refer to the Panel Deployment documentation.

Local Deployment (Windows/Linux/macOS)

Install Node.js

  • Windows:
    Download Node.js and install it. Verify installation:

    node -v
    npm -v
  • Linux:

    curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
    sudo apt install -y nodejs
    node -v
    npm -v
  • macOS:

    brew install node
    node -v
    npm -v

Install FFmpeg

  • Windows:
    Download FFmpeg, extract it, and add the bin folder to your PATH. Verify installation:

    ffmpeg -version
  • Linux:

    sudo apt update && sudo apt install ffmpeg
    ffmpeg -version
  • macOS:

    brew install ffmpeg
    ffmpeg -version

Install Yarn

Install globally:

npm install -g yarn
yarn -v

Install Git

  • Windows:
    Download Git and install it. Verify installation:

    git --version
  • Linux:

    sudo apt update && sudo apt install git
    git --version
  • macOS:

    brew install git
    git --version

Setup and Run

  1. Open a terminal.

  2. Clone the repository and start the bot:

    git clone https://github.com/AstroX11/Xstro.git
    cd Xstro
    yarn install
    npm start

Contributing

Want to help? Fork the repository, create a pull request, and make sure everything works.

Contribute Here

Disclaimer

This is my first JavaScript project—so expect some bugs. This project is not affiliated with WhatsApp. For official WhatsApp information, visit whatsapp.com.

About

A fast, lightweight WhatsApp bot powered Baileys Web API

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.6%
  • TypeScript 10.4%