Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukeocodes/guys-bot
Remake of https://glitch.com/~guys-bot-for-slack to work with new Slack APIs using Slack Node SDK.
https://github.com/lukeocodes/guys-bot
glitch guys-bot hacktoberfest heroku node slackbot slackbots
Last synced: about 1 month ago
JSON representation
Remake of https://glitch.com/~guys-bot-for-slack to work with new Slack APIs using Slack Node SDK.
- Host: GitHub
- URL: https://github.com/lukeocodes/guys-bot
- Owner: lukeocodes
- License: agpl-3.0
- Created: 2020-04-21T15:00:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:50:36.000Z (over 1 year ago)
- Last Synced: 2024-05-01T15:09:02.736Z (8 months ago)
- Topics: glitch, guys-bot, hacktoberfest, heroku, node, slackbot, slackbots
- Language: JavaScript
- Homepage: https://dev.to/lukeocodes/who-s-a-good-bot-a-slack-bot-for-inclusive-language-2fkh
- Size: 1.92 MB
- Stars: 16
- Watchers: 1
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://glitch.com/~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](https://dev.to/lukeocodes/who-s-a-good-bot-a-slack-bot-for-inclusive-language-2fkh), the supporting blog post for this application, on how to set up your Slack App to retrieve your SLACK_TOKEN and SLACK_SIGNING_SECRET.
## Installation
Get the repo.
```shell
git clone https://github.com/lukeocodes/guys-bot.git
cd guys-bot
```
Install it.
```shell
npm install
```
## Running it in Development Mode
### Configuration
```shell
cp .env.example .env
```
Update `.env` following the `.env.example` file supplied with the project.
### Run Dev
```shell
npm run dev
```
## Deploying it to Production
### To Start It
```shell
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](https://dev.to/lukeocodes/who-s-a-good-bot-a-slack-bot-for-inclusive-language-2fkh), an article supporting this repository with setup steps.
### Deploy to Heroku
[](https://heroku.com/deploy)
Once deployed, update your Heroku environment variables with the SLACK_TOKEN and SLACK_SIGNING_SECRET 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://.herokuapp.com/slack/events`.
### Remix on Glitch
[](https://glitch.com/edit/#!/import/github/lukeocodes/guys-bot)
Once remixed, update your `.env` file with the SLACK_TOKEN and SLACK_SIGNING_SECRET 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://.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 :)