Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vercel/hitbot

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/vercel/hitbot
Owner: vercel
Created: 2022-06-15T19:59:43.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-06-23T03:29:35.000Z (over 2 years ago)
Last Synced: 2024-12-17T23:23:13.002Z (18 days ago)
Language: TypeScript
Homepage: hitbot.vercel.sh
Size: 243 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Note Taker Slack App/Bot

This is a Slack Bot, using Vercel for serverless deployment and Upstash Redis for database.

## Deploy This Project on Vercel!

Simply fill the environmental variables defined below and your serverless functions will be up in seconds!

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fexamples%2Ftree%2Fmain%2Fsolutions%2Fslackbot&env=SLACK_SIGNING_SECRET,SLACK_BOT_TOKEN&integration-ids=oac_V3R1GIpkoJorr6fqyiwdhl17)

---

### What The Bot Does

- Events:
- New channel created:
- When a new is channel created, posts a message to `general` channel stating that such an event happened.
- Slackbot mentioned:
- Whenever the bot is mentioned, posts a
message to `general` channel stating
that the bot was mentioned.

![events](https://github.com/upstash/vercel-note-taker-slackbot/blob/main/public/events.png)

- Commands:
- `/note set ` :
- Sets a key value pair.
- `/note get ` :
- Gets the value corresponding to the key
- `/note list-set ` :
- Adds the `` to `` list as an item.
- `/note list-all ` :
- Lists all the items in the ``
- `/note list-remove ` :
- Removes `` from the ``

![slash_command](https://github.com/upstash/vercel-note-taker-slackbot/blob/main/public/slash_commands.png)

- P.S:
- All of the commands mentioned can be implemented as slackbot mentions rather than slash commands. For demonstration purposes, slash commands are also used. Use cases may differ.

---

### Configuring Slack Bot - 1

1. Go to [Slack API Apps Page](https://api.slack.com/apps):
- Create new App
- From Scratch
- Name your app & pick a workspace
- Go to Oauth & Permissions
- Add the following scopes
- app_mentions:read
- channels:read
- chat:write
- chat:write.public
- commands
- Install App to workspace
- Basic Information --> Install Your App --> Install To Workspace
2. Note the variables (These will be the env variables for vercel deployment) :
- `SLACK_SIGNING_SECRET`:
- Go to Basic Information
- App Credentials --> Signing Secret
- `SLACK_BOT_TOKEN`:
- Go to OAuth & Permissions
- Bot User OAuth Token

---

### Deploying on Vercel

1. Click the deploy button:

2. Fill the environmental variables defined above.

---

### Configuring Slack Bot - 2

- After deployment, you can use the provided `vercel_domain`.

1. Go to [Slack API Apps Page](https://api.slack.com/apps) and choose relevant app:

- Go to Slash Commands:
- Create New Command:
- Command : `note`
- Request URL : `/api/note`
- Configure the rest however you like.
- Go to Event Subscribtions:
- Enable Events:
- Request URL: `/api/events`
- Subscribe to bot events by adding:
- app_mention
- channel_created

2. After these changes, Slack may require reinstalling of the app.

---

### Running Locally

Use Vercel CLI to replicate serverless development environment:

`vercel dev` --> localhost address will be given.

- If you don't have a static IP, you will want to tunnel your localhost to a public IP. For that, you can use `ngrok`:

- ./ngrok http 3000 --> Tunnels your localhost:3000
- Provided address is the endpoint.

---

### Additionally

For additional explanations of the source code and how to run it locally, you can refer to [the blogpost](https://blog.upstash.com/vercel-note-taker-slackbot).