Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coslynx/discord-server-management-bot

Project: Discord Bot with 100+ Slash Commands, Automod, Music, Giveaways, Rankings, Polls. Created at https://spectra.codes, which is owned by @Drix10
https://github.com/coslynx/discord-server-management-bot

api-integration auto-moderation code-generation code-quality community-engagement developer-tools devops discord-bot discord-js giveaway-system javascript machine-learning mongodb music-bot music-streaming natural-language-processing node-js ranking-system server-management software-development

Last synced: 25 days ago
JSON representation

Project: Discord Bot with 100+ Slash Commands, Automod, Music, Giveaways, Rankings, Polls. Created at https://spectra.codes, which is owned by @Drix10

Awesome Lists containing this project

README

        




Comprehensive-Discord-Bot


A Multi-faceted Discord Bot for Server Management and Engagement


Developed with the software and tools below.



Programming Language - JavaScript
Framework - Discord.js
Database - MongoDB



git-last-commit
GitHub commit activity
GitHub top language

## ๐Ÿ“‘ Table of Contents
- ๐Ÿ“ Overview
- ๐Ÿ“ฆ Features
- ๐Ÿ“‚ Structure
- ๐Ÿ’ป Installation
- ๐Ÿ—๏ธ Usage
- ๐ŸŒ Hosting
- ๐Ÿ“„ License
- ๐Ÿ‘ Authors

## ๐Ÿ“ Overview
This repository hosts a multi-faceted Discord bot, designed to empower server administrators and enhance user engagement. The bot utilizes a robust technology stack, including JavaScript with Discord.js framework and MongoDB for data storage. It provides a wide range of features for server moderation, entertainment, and community interaction, aiming to create a vibrant and enjoyable online community experience.

## ๐Ÿ“ฆ Features

| | Feature | Description |
|----|--------------------|--------------------------------------------------------------------------------------------------------------------|
| โš™๏ธ | Architecture | The bot is structured with a modular architecture, dividing functionalities into distinct modules for better organization and maintainability. |
| ๐Ÿ“„ | Documentation | This README file offers comprehensive documentation, outlining project details, installation instructions, usage guides, and contribution guidelines. |
| ๐Ÿ”— | Dependencies | The bot leverages a range of packages like ytdl-core for music playback, dotenv for environment variable management, and others for enhanced functionality. |
| ๐Ÿงฉ | Modularity | The codebase follows a modular approach, dividing functionalities into separate files for improved maintainability and easier code comprehension. |
| ๐Ÿงช | Testing | The project incorporates unit testing practices to ensure the reliability and robustness of the codebase. |
| โšก๏ธ | Performance | The bot is optimized for performance, utilizing efficient algorithms and data structures to handle user requests and maintain responsiveness. |
| ๐Ÿ” | Security | Robust security measures, including input validation, data sanitization, and appropriate access control, are implemented to protect user data and server integrity. |
| ๐Ÿ”€ | Version Control| Git is used for version control, allowing for collaborative development and efficient tracking of changes. |
| ๐Ÿ”Œ | Integrations | The bot integrates with various APIs, including the Discord API, YouTube Data API, Spotify API, SoundCloud API, OpenAI API, and Google Cloud Vision API. |
| ๐Ÿ“ถ | Scalability | The bot is designed with scalability in mind, enabling it to handle increasing user activity and server size without compromising performance. |

## ๐Ÿ“‚ Structure
```
โ”œโ”€โ”€ bot
โ”‚ โ”œโ”€โ”€ src
โ”‚ โ”‚ โ”œโ”€โ”€ commands
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ user.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ help.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ ranking.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ moderation.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ poll.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ giveaway.ts
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ music.ts
โ”‚ โ”‚ โ”œโ”€โ”€ events
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ guildMemberRemove.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ guildMemberAdd.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ interactionCreate.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ messageCreate.ts
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ ready.ts
โ”‚ โ”‚ โ”œโ”€โ”€ services
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ user.service.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ ranking.service.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ moderation.service.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ poll.service.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ giveaway.service.ts
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ music.service.ts
โ”‚ โ”‚ โ”œโ”€โ”€ utils
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ embedBuilder.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ errorHandler.ts
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ logger.ts
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ commandHandler.ts
โ”‚ โ”‚ โ”œโ”€โ”€ config
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ database.config.ts
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ env.config.ts
โ”‚ โ”‚ โ””โ”€โ”€ main.ts
โ”‚ โ””โ”€โ”€ package.json
โ””โ”€โ”€ api
โ””โ”€โ”€ src
โ””โ”€โ”€ main.ts

```

## ๐Ÿ’ป Installation
### ๐Ÿ”ง Prerequisites
- Node.js
- npm

### ๐Ÿš€ Setup Instructions
1. Clone the repository:
- `git clone https://github.com/coslynx/Comprehensive-Discord-Bot.git`
2. Navigate to the project directory:
- `cd Comprehensive-Discord-Bot`
3. Install dependencies:
- `npm install`

## ๐Ÿ—๏ธ Usage
### ๐Ÿƒโ€โ™‚๏ธ Running the Project
1. Start the development server:
- `npm start`
2. Open your browser and navigate to [http://localhost:3000](http://localhost:3000).

### โš™๏ธ Configuration
Adjust configuration settings in 'config.js' or '.env'.

### ๐Ÿ“š Examples
- ๐Ÿ“ Example 1: How to use the music commands
- `!play `: Plays a song from YouTube
- `!queue `: Adds a song to the queue
- `!skip`: Skips the current song
- `!stop`: Stops the music playback
- ๐Ÿ“ Example 2: How to use the moderation commands
- `!mute `: Mutes a user
- `!unmute `: Unmutes a user
- `!kick `: Kicks a user from the server
- `!ban `: Bans a user from the server
- ๐Ÿ“ Example 3: How to use the giveaway commands
- `!giveaway `: Starts a new giveaway
- `!enter`: Enters the current giveaway
- `!endgiveaway`: Ends the current giveaway

## ๐ŸŒ Hosting
### ๐Ÿš€ Deployment Instructions
1. Prerequisites:
- Heroku account
- Heroku CLI (`npm install -g heroku`)
2. Deployment:
- `heroku login` (Log in to your Heroku account)
- `heroku create ` (Create a new Heroku app)
- `git push heroku main` (Deploy the code to Heroku)

### ๐Ÿ”‘ Environment Variables
- `DISCORD_TOKEN`: Your Discord bot token
- `MONGO_URI`: Your MongoDB connection string

## ๐Ÿ“œ License
This project is licensed under the [MIT](https://choosealicense.com/licenses/mit/) license.

## ๐Ÿ‘ฅ Authors
- Author Name - [Spectra.codes](https://spectra.codes)
- Creator Name - [DRIX10](https://github.com/Drix10)


๐ŸŒ Spectra.Codes




Why only generate Code? When you can generate the whole Repository!