Welcome to Freo, a versatile Discord bot designed to enhance your server experience with advanced giveaway features.
- Introduction
- Features
- Getting Started
- Configuration
- Running the Bot
- Try the Live Version
- Support
- Contributing
- Acknowledgments
- License
Freo is a powerful and customizable Discord bot that provides robust giveaway functionalities, advanced features to managing your server easier and more efficient.
- Advanced Giveaway With Button Support
- Logging for all commands executed
- Error logging for commands
- Integration with MongoDB for data persistence
- Support for Top.gg voting
- Node.js v14 or higher
- MongoDB database
- A Discord bot token from the Discord Developer Portal
-
Clone the repository:
git clone https://github.com/OG-Devcords/freo.git cd greethub
-
Install the dependencies:
npm install
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"
}
}
Start the bot using the following command:
node index.js
You can invite the live version of Freo to your server using this invite link.
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!
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!
This project was built with inspiration and assistance from the following repositories:
This project is licensed under the MIT License. See the LICENSE file for details.