Discord bot for CMU Courses, CMU Eats, and other ScottyLabs services
  • TypeScript 99.4%
  • Nix 0.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Nikhil R 81d04e5476
Some checks failed
nixbot/nix-eval evaluation succeeded
nixbot/nix-build 0 attributes built
kennel/deploy deployment healthy
CI / checks (pull_request) Has been cancelled
CI / checks-1 (pull_request) Has been cancelled
CI / checks (push) Has been cancelled
CI / checks-1 (push) Has been cancelled
feat: show geneds when /course is used
2026-11-18 22:37:10 -05:00
.forgejo refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
.vscode refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
docs refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
drizzle/20251216201838_powerful_turbo chore: add ci workflow to check, format, and lint (#83) 2026-01-17 17:10:02 -08:00
src feat: show geneds when /course is used 2026-11-18 22:37:10 -05:00
tests fix: update course catalog and syllabi data files (#259) 2026-11-08 19:38:03 +00:00
.editorconfig feat: update secretspec.toml 2026-06-09 14:54:23 -07:00
.env.example feat: use devenv, migrate to deno, and include secretspec (#194) 2026-06-08 05:06:14 +02:00
.gitignore refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
.oxlintrc.json feat: migrate some parts to more deno-friendly patterns 2026-06-20 11:58:18 +05:30
CODEOWNERS chore: remove redundancy in CODEOWNERS 2026-07-23 12:03:18 -04:00
deno.json refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
deno.jsr.hash build: add the jsr cache hash 2026-11-08 17:39:57 -05:00
deno.lock refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
drizzle.config.ts Revert "fix: read env vars via process.env for Bun runtime on Kennel" 2026-06-09 20:43:32 -04:00
flake.lock chore: update lockfiles 2026-11-16 00:03:05 +00:00
flake.nix refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
LICENSE-APACHE-2.0 chore: update to devops standards (#20) 2025-10-24 15:14:13 -04:00
LICENSE-MIT chore: update to devops standards (#20) 2025-10-24 15:14:13 -04:00
README.md refactor: migrate to the kennel flake module 2026-11-08 22:07:35 +00:00
secretspec.toml chore: update kennel 2026-11-11 00:50:14 -05:00

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

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 Lix (see 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

Log in to OpenBao as described in kennel's secrets guide, then enter the dev shell and start the bot and a local PostgreSQL database:

nix develop
pitchfork start --local

Database migrations and slash command registration happen automatically when the bot starts.

Deployment

Production runs on Kennel.

Contributing

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