https://github.com/dxheroes/slack-booking-bot
Slack bot to book your spot.
https://github.com/dxheroes/slack-booking-bot
Last synced: 6 months ago
JSON representation
Slack bot to book your spot.
- Host: GitHub
- URL: https://github.com/dxheroes/slack-booking-bot
- Owner: DXHeroes
- License: mit
- Created: 2024-10-24T04:18:28.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T06:48:58.000Z (12 months ago)
- Last Synced: 2024-11-24T19:52:34.726Z (11 months ago)
- Language: TypeScript
- Size: 57.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bolt for JavaScript (TypeScript) Template App
This is a generic Bolt for JavaScript (TypeScript) template app used to build out Slack apps.
Before getting started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and [create one](https://slack.com/create).
## Installation
#### Create a Slack App
1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and choose "From an app manifest"
2. Choose the workspace you want to install the application to
3. Copy the contents of [manifest.json](./manifest.json) into the text box that says `*Paste your manifest code here*` (within the JSON tab) and click _Next_
4. Review the configuration and click _Create_
5. Click _Install to Workspace_ and _Allow_ on the screen that follows. You'll then be redirected to the App Configuration dashboard.
#### Environment Variables
Before you can run the app, you'll need to store some environment variables.
1. Copy `env.sample` to `.env`
2. Open your apps configuration page from [this list](https://api.slack.com/apps), click _OAuth & Permissions_ in the left hand menu, then copy the _Bot User OAuth Token_ into your `.env` file under `SLACK_BOT_TOKEN`
3. Click _Basic Information_ from the left hand menu and follow the steps in the _App-Level Tokens_ section to create an app-level token with the `connections:write` scope. Copy that token into your `.env` as `SLACK_APP_TOKEN`.
#### Install Dependencies
`pnpm install`
#### Run Bolt Server
`pnpm start`
## Project Structure
### `manifest.json`
`manifest.json` is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.
### `app.ts`
`app.ts` is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.
### `/listeners`
Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/shortcuts` handles incoming [Shortcuts](https://api.slack.com/interactivity/shortcuts) requests, `/listeners/views` handles [View submissions](https://api.slack.com/reference/interaction-payloads/views#view_submission) and so on.
## App Distribution / OAuth
Only implement OAuth if you plan to distribute your application across multiple workspaces. A separate `app-oauth.ts` file can be found with relevant OAuth settings.
When using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used [`ngrok`](https://ngrok.com/download). Checkout [this guide](https://ngrok.com/docs#getting-started-expose) for setting it up.
Start `ngrok` to access the app on an external network and create a redirect URL for OAuth.
```
ngrok http 3000
```
This output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following:
```
Forwarding https://3cb89939.ngrok.io -> http://localhost:3000
```
Navigate to **OAuth & Permissions** in your app configuration and click **Add a Redirect URL**. The redirect URL should be set to your `ngrok` forwarding address with the `slack/oauth_redirect` path appended. For example:
```
https://3cb89939.ngrok.io/slack/oauth_redirect
```