https://github.com/hackgt/staff-slack-hub
A centralized hub for HackGT staff slack apps
https://github.com/hackgt/staff-slack-hub
Last synced: about 1 year ago
JSON representation
A centralized hub for HackGT staff slack apps
- Host: GitHub
- URL: https://github.com/hackgt/staff-slack-hub
- Owner: HackGT
- License: mit
- Created: 2020-06-08T20:22:44.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-26T02:18:19.000Z (about 1 year ago)
- Last Synced: 2025-02-26T03:24:23.772Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.54 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
The Staff Slack Hub seeks to combine multiple staff slack apps used during a hackathon into one bot. As of now, these include the schedule bot (for changing event timings), buzzer ui (to send notifications), and profile pic (to add the organizer overlay). The main goal is to increase code sharing between these 3 sub-apps and provide a better framework for future extension.
# Usage
To start using the app, use the slash command `/hub`. In order to have permission to use the app, a slack user must be in the “staff channel” as defined in `config.json`. The app will ask the user for OAuth permission to update their profile components and send messages as the user.
# Deployment Guide
When using Google Cloud Run, you'll need to always allocate CPU. Curently, the slack app uses webhooks to update the profile pic overlay, and if CPU isn't always allocated, there will be no CPU left after the initial request response. As such, before the event when the event slack is up, change the CPU allocation setting to CPU is always allocated. **Please remember to update this setting back** to CPU is only allocated during request processing after the event is over to prevent excess Google Cloud charges.
# Install to new Workspace
To install the app to a new workspace, visit the `/installation` url (ex. `https://staff-slack-hub.hexlabs.org/installation`). Then, select the workspace from the dropdown in the top right of the page, and install it to the new workspace. Now, any user in the workspace can access the Staff Hub commands. To change the scopes requested from the user, look in the `app.js` file.
# Notes
From past usage, the profile pic plugin needs at least 350Mi of memory to process the images properly, so please provide at least this much in the configuration. Additionally, please make sure to update the CMS and Buzzer secrets between deployments.