Simple Guys Bot

If you're as concious as I am about the use of language in your Slack workspace, this will interest you.

With the existing guys-bot-for-slack needing some updates to work with the latest flavour of Slack API, I chose to recreate it using the most basic implementation of the Slack SDKs.

The bot responds with an ephemeral message, not seen by anyone but the user who originally messaged.

It requires the bot be invited into the channels you want it to listen on, so it can be implemented by individuals, or teams, as channels require, if that is what you want.

This guide has steps on the Slack API control panel. Please read Who's a Good Bot? A Slack Bot For Inclusive Language, the supporting blog post for this application, on how to set up your Slack App to retrieve your SLACK_SIGNING_SECRET and SLACK_BOT_USER_OAUTH_ACCESS_TOKEN.

Installation

Get the repo.

git clone https://github.com/lukeocodes/guys-bot.git
cd guys-bot

Install it.

npm install

Running it in Development Mode

Configuration

cp .env.example .env

Update .env following the .env.example file supplied with the project.

Run Dev

npm run dev

Deploying it to Production

To Start It

npm start

Click to Deploy Options

More information on setting up your Slack App can be found in Who's a Good Bot? A Slack Bot For Inclusive Language, an article supporting this repository with setup steps.

Deploy to Heroku

Once deployed, update your Heroku environment variables with the SLACK_SIGNING_SECRET and SLACK_BOT_USER_OAUTH_ACCESS_TOKEN from your Slack App. Once configured head over to your Slack app's Event Subscription page (https://api.slack.com/apps/YOUR_APP_ID/event-subscriptions?) and update your request URL to be https://<your-heroku-app>.herokuapp.com/slack/events.

Remix on Glitch

Once remixed, update your .env file with the SLACK_SIGNING_SECRET and SLACK_BOT_USER_OAUTH_ACCESS_TOKEN from your Slack App. Once configured head over to your Slack app's Event Subscription page (https://api.slack.com/apps/YOUR_APP_ID/event-subscriptions?) and update your request URL to be https://<your-glitch-project>.glitch.me/slack/events.

Logo

Guy - whos a good bot - is saved as SVG and is subject to the same license for the project. Enjoy :)

Docker

Build

docker build --file dockerfile.worker --tag language-matters-bot:1.0 . docker run --publish 3000:3000 --detach --name lmb language-matters-bot:1.0

Slackbot

Application Setup

Create a slack application https://api.slack.com/apps

Add the following features: ... (TBD)

Install the application to the target workspace.

Copy the SLACK_BOT_USER_OAUTH_ACCESS_TOKEN and SLACK_SIGNING_SECRET to the local .env file or server environment variables.