@globalart/nestcord/README.md

A module for creating Discord bots using NestJS, based on Discord.js

<div align="center">
   <h1>
       <a href="#"><img src="https://nestcord.js.org/img/logo.png" alt="NestCord Logo"></a>
   </h1>
   🤖 A versatile NestJS module for creating <b><a href="https://discord.com/">Discord</a> bots</b>, powered by <a href="https://discord.js.org/">Discord.js</a>.
   <br/><br/>
   <a href="https://nestcord.js.org">Documentation ✨</a> &emsp; <a href="https://github.com/GlobalArtInc/nestcord">Source Code 🪡</a> &emsp; <a href="https://github.com/GlobalArtInc/nestcord/tree/master/examples">Examples 🛠️</a> &emsp; <a href="https://discord.gg/4Tc9hssSAv">Community 💬</a>
</div>

<br/>

<p align="center">
  <a href='https://img.shields.io/npm/v/@globalart/nestcord'><img src="https://img.shields.io/npm/v/@globalart/nestcord" alt="NPM Version" /></a>
  <a href='https://img.shields.io/npm/dm/@globalart/nestcord'><img src="https://img.shields.io/npm/dm/@globalart/nestcord" alt="NPM Downloads" /></a>
</p>

## About

NestCord is a NestJS module designed to streamline the creation of Discord bots by utilizing the power of [Discord.js](https://github.com/discordjs/discord.js) under the hood. This mono-repository offers a structured approach to bot development, allowing deep integration with NestJS’s ecosystem for a seamless and powerful bot-building experience.

### Key Features

- **Easy Setup & Flexible Architecture:** Get started quickly with customizable components.
- **Powerful Custom Decorators:** Build reusable, specialized components.
- **Comprehensive Discord Interactions:** Supports Slash Commands, Context Menus, Message Components, and Event Listeners.
- **Full NestJS Compatibility:** Integrate with guards, interceptors, filters, and pipes for full NestJS support.

For help and support, refer to the [Issues](https://github.com/GlobalArtInc/nestcord/issues/new?assignees=&labels=question&template=question.yml) page.

## Installation

**Node.js 16.6.0 or newer is required.**

```bash
$ npm i @globalart/nestcord discord.js
$ yarn add @globalart/nestcord discord.js
$ pnpm add @globalart/nestcord discord.js
```