mirror of
https://github.com/arthur-pbty/discord.js-bot.git
synced 2026-06-03 23:36:33 +02:00
arthur
110 lines
2.4 KiB
Markdown
110 lines
2.4 KiB
Markdown
# Discord.js Bot
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
An advanced Discord bot designed to offer a wide range of interactive and management features for online communities.
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Commands](#commands)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
- [Contact](#contact)
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
To get started with **discord.js-bot**, follow these steps:
|
|
|
|
1. **Clone the repository:**
|
|
|
|
```bash
|
|
git clone https://github.com/arthur-pbty/discord.js-bot.git
|
|
cd discord.js-bot
|
|
```
|
|
|
|
2. **Install dependencies:**
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. **Set up environment variables:**
|
|
|
|
- Create a `.env` file in the root directory.
|
|
- Add your Discord bot token:
|
|
|
|
```plaintext
|
|
TOKEN=your_discord_bot_token_here
|
|
```
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
### Development Mode
|
|
|
|
Start the bot with automatic restart using nodemon:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
### Production Mode
|
|
|
|
Build and start the bot:
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
### Deploy Commands
|
|
|
|
Update Discord bot commands (slash commands):
|
|
|
|
```bash
|
|
npm run deploy
|
|
```
|
|
|
|
---
|
|
|
|
## Commands
|
|
|
|
- **npm run build:** Compile TypeScript to JavaScript.
|
|
- **npm run prettier:** Format code using Prettier.
|
|
- **npm run prettier-check:** Check code formatting without modification.
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
|
|
|
1. Fork the Project
|
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
|
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
|
5. Open a Pull Request
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|
|
|
|
---
|
|
|
|
## Contact
|
|
|
|
Arthur PBTY - [GitHub](https://github.com/arthur-pbty)
|
|
|
|
Project Link: [https://github.com/arthur-pbty/discord.js-bot](https://github.com/arthur-pbty/discord.js-bot) |