{"id":15764415,"url":"https://github.com/devjiwonchoi/vercel-slackbot","last_synced_at":"2025-03-31T10:20:33.122Z","repository":{"id":233718053,"uuid":"740948317","full_name":"devjiwonchoi/vercel-slackbot","owner":"devjiwonchoi","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-09T11:58:31.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-11T12:09:01.802Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://vercel-slackbot-six.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devjiwonchoi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-01-09T11:58:25.000Z","updated_at":"2024-01-09T11:59:45.000Z","dependencies_parsed_at":"2024-04-17T07:20:40.684Z","dependency_job_id":"d7bb21e9-811c-491e-8255-35f7db11eb40","html_url":"https://github.com/devjiwonchoi/vercel-slackbot","commit_stats":null,"previous_names":["devjiwonchoi/vercel-slackbot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjiwonchoi%2Fvercel-slackbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjiwonchoi%2Fvercel-slackbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjiwonchoi%2Fvercel-slackbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjiwonchoi%2Fvercel-slackbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devjiwonchoi","download_url":"https://codeload.github.com/devjiwonchoi/vercel-slackbot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246450478,"owners_count":20779421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T12:03:16.612Z","updated_at":"2025-03-31T10:20:33.092Z","avatar_url":"https://github.com/devjiwonchoi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Note Taker Slack App/Bot\n\nThis is a Slack Bot, using Vercel for serverless deployment and Upstash Redis for database.\n\n## Deploy This Project on Vercel!\n\nSimply fill the environmental variables defined below and your serverless functions will be up in seconds!\n\n[![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\u0026env=SLACK_SIGNING_SECRET,SLACK_BOT_TOKEN\u0026integration-ids=oac_V3R1GIpkoJorr6fqyiwdhl17)\n\n---\n\n### What The Bot Does\n\n- Events:\n  - New channel created:\n    - When a new is channel created, posts a message to `general` channel stating that such an event happened.\n  - Slackbot mentioned:\n    - Whenever the bot is mentioned, posts a\n      message to `general` channel stating\n      that the bot was mentioned.\n\n![events](https://github.com/upstash/vercel-note-taker-slackbot/blob/main/public/events.png)\n\n- Commands:\n  - `/note set \u003ckey\u003e \u003cvalue\u003e` :\n    - Sets a key value pair.\n  - `/note get \u003ckey\u003e` :\n    - Gets the value corresponding to the key\n  - `/note list-set \u003clist_name\u003e \u003citem_as_string\u003e` :\n    - Adds the `\u003citem_as_string\u003e` to `\u003clist_name\u003e` list as an item.\n  - `/note list-all \u003clist_name\u003e` :\n    - Lists all the items in the `\u003clist_name\u003e`\n  - `/note list-remove \u003clist_name\u003e \u003citem_as_string\u003e` :\n    - Removes `\u003citem_as_string\u003e` from the `\u003clist_name\u003e`\n\n![slash_command](https://github.com/upstash/vercel-note-taker-slackbot/blob/main/public/slash_commands.png)\n\n- P.S:\n  - 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.\n\n---\n\n### Configuring Slack Bot - 1\n\n1. Go to [Slack API Apps Page](https://api.slack.com/apps):\n   - Create new App\n     - From Scratch\n     - Name your app \u0026 pick a workspace\n   - Go to Oauth \u0026 Permissions\n     - Add the following scopes\n       - app_mentions:read\n       - channels:read\n       - chat:write\n       - chat:write.public\n       - commands\n     - Install App to workspace\n       - Basic Information --\u003e Install Your App --\u003e Install To Workspace\n2. Note the variables (These will be the env variables for vercel deployment) :\n   - `SLACK_SIGNING_SECRET`:\n     - Go to Basic Information\n       - App Credentials --\u003e Signing Secret\n   - `SLACK_BOT_TOKEN`:\n     - Go to OAuth \u0026 Permissions\n       - Bot User OAuth Token\n\n---\n\n### Deploying on Vercel\n\n1. Click the deploy button:\n\n[![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\u0026env=SLACK_SIGNING_SECRET,SLACK_BOT_TOKEN\u0026integration-ids=oac_V3R1GIpkoJorr6fqyiwdhl17)\n\n2. Fill the environmental variables defined above.\n\n---\n\n### Configuring Slack Bot - 2\n\n- After deployment, you can use the provided `vercel_domain`.\n\n1. Go to [Slack API Apps Page](https://api.slack.com/apps) and choose relevant app:\n\n   - Go to Slash Commands:\n     - Create New Command:\n       - Command : `note`\n       - Request URL : `\u003cvercel_domain\u003e/api/note`\n       - Configure the rest however you like.\n   - Go to Event Subscribtions:\n     - Enable Events:\n       - Request URL: `\u003cvercel_domain\u003e/api/events`\n     - Subscribe to bot events by adding:\n       - app_mention\n       - channel_created\n\n2. After these changes, Slack may require reinstalling of the app.\n\n---\n\n### Running Locally\n\nUse Vercel CLI to replicate serverless development environment:\n\n`vercel dev` --\u003e localhost address will be given.\n\n- 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`:\n\n- ./ngrok http 3000 --\u003e Tunnels your localhost:3000\n- Provided address is the endpoint.\n\n---\n\n### Additionally\n\nFor 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjiwonchoi%2Fvercel-slackbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevjiwonchoi%2Fvercel-slackbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjiwonchoi%2Fvercel-slackbot/lists"}