- TypeScript 99.4%
- Nix 0.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
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
|
||
| .forgejo | ||
| .vscode | ||
| docs | ||
| drizzle/20251216201838_powerful_turbo | ||
| src | ||
| tests | ||
| .editorconfig | ||
| .env.example | ||
| .gitignore | ||
| .oxlintrc.json | ||
| CODEOWNERS | ||
| deno.json | ||
| deno.jsr.hash | ||
| deno.lock | ||
| drizzle.config.ts | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE-APACHE-2.0 | ||
| LICENSE-MIT | ||
| README.md | ||
| secretspec.toml | ||
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, which you can join through governance
- Lix, installed by following kennel's local development guide
Setup
For detailed setup instructions including creating a Discord bot, obtaining API credentials, and configuring your development environment, see docs/SETUP.md.
Quick setup:
- Install Lix (see above)
- Create a Discord bot at https://discord.com/developers/applications and invite it to a server you can test in
- Get your
DISCORD_TOKENandDISCORD_CLIENT_IDand 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!