Skip to content

Capstone-Projects-2023-Fall/project-bereal-meets-slack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open in Codespaces

WhatchaDoin Bot

A community building bot that merges BeReal with Discord

Report Issue on Jira Deploy Docs Documentation Website Link

Background

This photo sharing is similar to the BeReal app which prompts users to post photos once a day to share with people they have added as friends. Our project differs in the fact that it will be used in communities of people who may not already be friends. BeReal users can only see the photos of people they have added.

DiscordAPI

Dev Installation Instructions

  • Make Sure you have nodeJs installed (any ver 20+ works)
  • Make sure docker is installed
  • Clone the repo
  • Create a file named .env and provide it with a discord token, DB connection info.
  • Run docker compose up or alternative to run the bot.

WhatchaDoin' Bot Slash Commands

/submit

Description

A Discord slash command for users to submit posts.

Options:

  • file (Required): Attach a file to the submission.
  • caption: Provide a caption for the submission.

/activehours

Description

View and manage active hours for prompts.

Subcommands:

/set

Set the bot's active hours.

Options:
  • start-time (Required): Enter the start time in HH:MM format.
  • end-time (Required): Enter the end time in HH:MM format.

/list

List the active hours.

/blacklist

Description

A Discord slash command for moderators to manage the blacklist of users.

Subcommands:

/add

Add a user to the blacklist.

Options:
  • user (Required): The user you want to add to the blacklist.

/remove

Remove a user from the blacklist.

Options:
  • user (Required): The user you want to remove from the blacklist.

/list

List users in the blacklist.

/exportcsv

Description

Discord slash command to export and save data to a CSV file, and then uploading it to the chat.

Permissions

  • Required Role: bot mod (Only moderators can use this command)

/graphdata

Description

Displays a graph based on the provided data.

Permissions

  • Required Role: bot mod (Only moderators can use this command)

/help

Description

A Discord slash command to display help information.

/post

Description

A Discord slash command to send a prompted post.

Subcommands:

/random

Prompt a random user.

/someone

Prompt a specified user.

Options:
  • user (Required): Prompt a specific user.

Permissions

  • Required Role: bot mod (Only moderators can use this command)

/toggle_private

Description

A Discord slash command to toggle between public and private responses.

Description

Toggles the bot to send direct messages (DMs) to the user instead of public replies.

/prompts

Description

A Discord slash command to manage prompts.

Subcommands:

/add

Add a new prompt.

Options:
  • prompt (Required): Enter a new prompt.
  • channel (Optional): Select the channel for the prompt.

/delete

Delete a prompt from the list. The command includes an autocomplete function that provides suggestions based on user input.

Permissions

  • Required Role: bot mod (Only moderators can use this command)
Options:
  • prompt (Required): Enter the prompt to delete.

/list

List all prompts.

/setsubmissionchannel

Description

A Discord slash command to set the submission channel for the guild.

Options:

  • channel (Required): The channel for submissions.

Permissions

  • Required Role: bot mod (Only moderators can use this command)

/notifications

Description

A Discord slash command to toggle bot notifications on and off.

Collaborators

+
Rishi Duggal
Rishi Duggal
Vivek Patel
Vivek Patel
Tara Feeley
Tara Feeley
Rachel To
Rachel To
Gevork Dramagotchian
Gevork Dramagotchian
Sojel Sunny
Sojel Sunny
Christian Smith
Christian Smith
Nick Sowers
Nick Sowers