Dalmatian

Dalmatian is a Discord bot designed for CMU students, providing easy access to campus resources like CMU Courses and CMU Eats right at your fingertips!

Getting Started

Prerequisites

• devenv - Developer environment
• direnv - shell extension (that we use for devenv)

(You'll need Nix as well, but devenv gives you that command.)

Setup

For detailed setup instructions including creating a Discord bot, obtaining API credentials, and configuring your development environment, see docs/CONTRIBUTING.md.

Quick setup:

1. Install devenv and direnv (see links above)
2. Create a Discord bot at [https://discord.com/developers/applications]
3. Get your DISCORD_TOKEN and DISCORD_CLIENT_ID

Running the Bot

# Set up environment variables (see CONTRIBUTING.md for details)
cp .env.example .env
# Edit .env with your Discord bot credentials

# Start the environment
devenv up

Deployment

Production runs on Kennel via devenv and secretspec.

Contributing

Please read CONTRIBUTING.md before you contribute to this project!