Internbot

Simple serverless Slack bot for DTI Coffee Chats and Birthday messages!

Should pair up people in the #coffee-chats channel every week.

Functionality

If you're a regular member, you should only be able to login, edit your own birthday, or report on whether the bot is up or down.

If you're an admin, you should be able to login, edit your own birthday, edit other people's birthdays, toggle the bot on or off, and also manually initiate a new semester, or trigger a round of coffee chats or birthday wishes as needed.

New to Internbot?

If you're a new Lead, make a PR to add yourself to the array of admins in lib/data/admins.ts and merge it in. Then, login with Google and you should have access to the admin panel!

If you're a regular member, just login with Google.

For everyone, please login with your Cornell email.

Technology

Built with Vercel, PostgreSQL, Prisma, Next.js, Jest, and TypeScript.

Specifically,

• Vercel Cron for scheduling
• Vercel Serverless Functions for API
• Vercel Serverless Database for PostgreSQL
• Prisma for Object-Relational Mapping
• TypeScript for type safety
• Next.js for React Framework
  • Experimental: React Server Components with Server Actions, to deliver server-side-rendered React components with server actions (e.g. database manipulations) co-located within the component.
  • Experimental: App Directory for organizing Next.js pages, layouts, error handling and routing.
  • And More Features! (Async components and Suspense; Parallel Routes, etc.)
• Tailwind CSS for styling
• Jest for testing
• Clerk for authentication

Development

pnpm install              # Install Dependencies
pnpm dlx prisma generate  # Generate Prisma type definitions
pnpm dev                  # Start Development Server
pnpm test                 # Run Tests
pnpm deploy               # Deploy to Vercel

Roadmap

Features

• Populate database with Slack users biannually or manually.
• Send out coffee chat pairings on a weekly basis or manually.
• Authentication with Slack, limited to emails in the database.
• Edit user info: active/inactive, birthday.
• Global bot disable/enable.
• Send out birthday messages whenever a user's birthday is today!

!Testing!

• Add Github Actions for testing.
• Add unit tests for pairing algorithm, including when bot is disabled.
• Add unit tests for birthday messaging, including when bot is disabled.
• Add unit tests for populating the database correctly.
• Add unit tests for all components.

Improvements

• Polish up the UI.
• Allow admins to bulk edit user birthdays, activity, etc.
• Add a separate model for Admins that's separate from All-Members-in-Slack. Block access to gated actions unless specifically an Admin. Allow old Admins to set new Admins.
• Add migration scripts for clearing out old semesters, schema changes, etc.
• Add remaining cronjob in oldvercel.json to vercel.json.