Skip to content
ScottyLabsPublic

About

READ-ONLY MIRROR

Resources

Contributing

Stars

7 stars

Watchers

2 watching

Forks

Repository files navigation

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!

About

READ-ONLY MIRROR

Resources

Contributing

Stars

7 stars

Watchers

2 watching

Forks

Used by

Contributors

Languages