beacon
beacon copied to clipboard
A Slack bot for non verbal cues to make it easier on your mental health to tell people you're out of action for the day.
Beacon
A Slack bot that creates a one-way communication channel to people for when you're too sick to deal with human interaction but still need to let people know you're not well.
Content
- Installation
- Customization
- Development
- Version History
Installation
To install this app yourself you have to host it online and install a new app in slack via https://api.slack.com/apps. It will need bot token scope:
-
chat:write
-
chat:write.customize
-
im:read
-
im:write
-
users:read
-
app_mentions:read
And you'll need to copy the User OAuth Token
and the Bot User OAuth Token
into your .env
file which you can get from the OAuth & Permissions
page of your app. And create a App-Level Tokens
under Basic Information
with both connections:write
and authorizations:read
.
Lastly you have to add the url to Slack in both the Event Subscriptions
and Interactivity & Shortcuts
sections.
Note that the app is listening on the path slack/events
.
Inside Event Subscriptions
make sure you add the following events under Subscribe to bot events
:
-
app_home_opened
-
app_mention
-
message.im
Customization
This app comes with a home screen that allows you to send messages to people in the slack workspace.
You can make changes to the home screen by editing the src/home.js
file.
Use the https://app.slack.com/block-kit-builder to help you edit this file.
Development
To run this repo please install dependencies via yarn
and run the app via yarn start
.
After changes please run yarn format
to run prettier
.
Version History
- v1.2.0 - Added health route, Updated dependencies, added Heroku button
- v1.3.0 - Added slack command feedback
- v1.2.0 - Added more information to the default message
- v1.1.0 - Added more details to the home screen
- v1.0.0 - First release