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! Made in TypeScript using Discord.js.

Try some of dalmatian's bot commands!

• /fce - View and compare Faculty Course Evaluations (FCEs) across semesters and professors
• /dining - View the statuses of dining locations on campus
• /course - Look up information about a specific course

To add Dalmatian to your server, click here!

Getting Started

Prerequisites

• Be a member of Community-Based Projects
• devenv - provides Deno and other tooling via Nix

Setup

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

Quick setup:

1. Install devenv (see link above)
2. Create a Discord bot at https://discord.com/developers/applications and invite it to a server you can test in
3. Get your DISCORD_TOKEN and DISCORD_CLIENT_ID and put them in .env:

   cp .env.example .env
   # Edit .env with your Discord bot credentials
   

Running the Bot

Authenticate once per machine with:

nix run git+https://git.cmu.dev/ScottyLabs/kennel#login

Then start the bot and a local PostgreSQL database:

devenv up

Database migrations and slash command registration happen automatically when the bot starts. The first run may take a while as devenv downloads its tooling.

Deployment

Production runs on Kennel via devenv and secretspec.

Contributing

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