/GreetHub

GreetHub is an open-source Discord welcome bot developed using discord.js v14. It provides a seamless and customizable way to greet new members as they join your server, making them feel welcome and informed right from the start.

Primary LanguageJavaScriptMIT LicenseMIT

GreetHub

Discord GitHub stars License: MIT

Welcome to GreetHub, a versatile Discord bot designed to enhance your server experience with advanced greeting and logging features.

Table of Contents

Introduction

GreetHub is a powerful and customizable Discord bot that provides robust greeting functionalities, command logging, and error tracking to make managing your server easier and more efficient.

Features

  • Customizable welcome messages
  • Logging for all commands executed
  • Error logging for commands
  • Integration with MongoDB for data persistence
  • Support for Top.gg voting

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/greethub.git
    cd greethub
  2. Install the dependencies:

    npm install

Configuration

Create a .env file in the root directory and add your configuration details:

TOKEN=YOUR_DISCORD_TOKEN_HERE
MONGO_DB=YOUR_MONGO_DB_CONNECTION_STRING_HERE
CLIENT_ID=YOUR_CLIENT_ID_HERE
TOPGG_TOKEN=YOUR_TOPGG_TOKEN_HERE

Alternatively, you can directly edit the config.js file:

module.exports = {
  TOKEN: process.env.TOKEN || "YOUR_DISCORD_TOKEN_HERE",
  MONGO_DB: process.env.MONGO_DB || "YOUR_MONGO_DB_CONNECTION_STRING_HERE",
  CLIENT_ID: process.env.CLIENT_ID || "YOUR_CLIENT_ID_HERE",
  OWNERS: ["YOUR_DISCORD_USER_ID_HERE"],
  SUPPORT_SERVER: "https://discord.com/invite/fDrwgNG5UN",
  CHANNELS: {
    COMMANDS_LOGS: "YOUR_COMMANDS_LOG_CHANNEL_ID_HERE",
    ERROR_COMMAND_LOGS: "YOUR_ERROR_COMMAND_LOG_CHANNEL_ID_HERE"
  },
  TOPGG: {
    STATUS: true,
    TOKEN: "YOUR_TOPGG_TOKEN_HERE"
  }
}

Running the Bot

Start the bot using the following command:

node index.js

Try the Live Version

You can invite the live version of GreetHub to your server using this invite link.

Support

If you enjoy using GreetHub, please consider supporting us by voting on Top.gg. Your votes help us reach more users and improve the bot!

Contributing

We welcome contributions! If you have suggestions for new features or find a bug, please open an issue or submit a pull request on GitHub. Don't forget to star the repo if you like it!

License

This project is licensed under the MIT License. See the LICENSE file for details.