Skip to content

Nevylish/UppercaseBot

Repository files navigation

UppercaseBot

Version Licence Node.js TypeScript

A Discord bot that helps you create and rename channels with alternative uppercase letters https://uppercasebot.nevylish.fr/

πŸš€ Usage

  1. Add the bot to your server using the link below:
https://discord.com/oauth2/authorize?client_id=1072283043739467807&permissions=8&integration_type=0&scope=bot+applications.commands
  1. Use the commands:
  • /create-channel - Create a new channel with alternative uppercase letters
  • /rename-channel - Rename an existing channel with alternative uppercase letters

πŸ’» For Developers

Prerequisites

  • Node.js 20 or higher
  • npm or pnpm

Installation

  1. Clone the repository
git clone https://github.com/nevylish/UppercaseBot.git
cd UppercaseBot
  1. Install dependencies
npm install
  1. Configure environment Create a .env file in the root directory:
TOKEN=your_discord_bot_token
TOPGG_TOKEN=your_topgg_token #optional for dev
WEBHOOK_URL=your_webhook_url #optional for dev
DASHBOARD_USERNAME=your_dashboard_username
DASHBOARD_PASSWORD=your_dashboard_password
DASHBOARD_DOMAIN=your_dashboard_domain
  1. Start the application
npm run build
npm run start

Project Structure

UppercaseBot/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ base/              # Core application
β”‚   β”œβ”€β”€ commands/          # Discord commands
β”‚   β”œβ”€β”€ exception/         # Error handling
β”‚   β”œβ”€β”€ public/            # Static files
β”‚   β”œβ”€β”€ types/             # TypeScript types
β”‚   β”œβ”€β”€ utils/             # Utility functions
β”‚   β”œβ”€β”€ index.ts           # Entry point
β”‚   └── shard.ts           # Sharding manager
β”œβ”€β”€ dist/                  # Compiled files
β”œβ”€β”€ .env                   # Environment variables
β”œβ”€β”€ .prettierrc            # Formatting configuration
β”œβ”€β”€ docker-compose.yml     # Docker configuration
β”œβ”€β”€ Dockerfile             # Docker image configuration
β”œβ”€β”€ package.json           # Dependencies and scripts
└── tsconfig.json          # TypeScript configuration

Available Scripts

Command Description
npm run build Build the TypeScript project
npm run dev Compile TypeScript in watch mode
npm run start Start the bot
npm run clean Clean the dist directory
npm run format Format code using Prettier

🐳 Docker

Quick Deployment

The project can be easily deployed using Docker Compose.

docker-compose up -d

🀝 Contributing

This project is open for contributions!

πŸ“„ License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

πŸ“ž Support

For support, please:


Built with ❀️ by Nevylish

About

πŸ€– Discord - Finally, use uppercase letters for your channel names.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •