init project

2026-06-17 08:07:41 +02:00 · 2024-06-29 15:07:14 +02:00
commit 516ae5892a
13 changed files with 2854 additions and 0 deletions
@@ -0,0 +1,110 @@
+# Discord.js Bot
+
+![GitHub repo size](https://img.shields.io/github/repo-size/arthur-pbty/discord.js-bot)
+![GitHub contributors](https://img.shields.io/github/contributors/arthur-pbty/discord.js-bot)
+![GitHub stars](https://img.shields.io/github/stars/arthur-pbty/discord.js-bot?style=social)
+![GitHub forks](https://img.shields.io/github/forks/arthur-pbty/discord.js-bot?style=social)
+![GitHub license](https://img.shields.io/github/license/arthur-pbty/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)