Skip to content

OrangeCal is a simple reminder setting bot for Discord

Notifications You must be signed in to change notification settings

masonschafercodes/orange-cal

Repository files navigation

OrangeCal

OrangeCal is a Discord bot designed to manage reminders and notifications within a Discord server.

Features

  • Register and deregister commands dynamically
  • Handle user interactions with commands and buttons
  • Manage reminder notifications using queues

Getting Started

Prerequisites

  • Node.js
  • pnpm

Installation

  1. Clone the repository:

    git clone <repository-url>
    cd orange-cal
  2. Install dependencies:

    pnpm install
  3. Create a .env file and add your configuration:

    DISCORD_TOKEN=your-discord-token
    CLIENT_ID=your-client-id
    REDIS_HOST=your-redis-host
    REDIS_PORT=your-redis-port

Running the Bot

To start the bot in development mode:

pnpm dev

To start the bot in production mode:

pnpm build
pnpm start

To lint the code:

pnpm lint

To format the code:

pnpm prettier

Adding Bot to Discord Server

  1. Create a new application on the Discord Developer Portal.

  2. Add a bot to the application.

  3. Copy the bot token and add it to the .env file.

  4. Add the bot to your Discord server using the following URL:

    https://discord.com/oauth2/authorize?client_id=<CLIENT_ID>&permissions=1689934340028480&scope=bot%20applications.commands
    

    Replace <CLIENT_ID> with your application's client ID.

Contributing

Feel free to open issues or submit pull requests for any improvements or bug fixes.

About

OrangeCal is a simple reminder setting bot for Discord

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published