https://github.com/hiro-o918/slack-app-sandbox
https://github.com/hiro-o918/slack-app-sandbox
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hiro-o918/slack-app-sandbox
- Owner: hiro-o918
- License: mit
- Created: 2024-01-30T02:58:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T22:23:29.000Z (about 1 year ago)
- Last Synced: 2024-04-16T02:09:58.925Z (about 1 year ago)
- Language: Python
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Bolt for Python Template App
This is a generic Bolt for Python 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. Open your apps configuration page from this list, click **OAuth & Permissions** in the left hand menu, then copy the Bot User OAuth Token. You will store this in your environment as `SLACK_BOT_TOKEN`.
2. 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 this token. You will store this in your environment as `SLACK_APP_TOKEN`.
```zsh
# Replace with your app token and bot token
export SLACK_BOT_TOKEN=
export SLACK_APP_TOKEN=
```
### Setup Your Local Project
```zsh
# Clone this project onto your machine
git clone https://github.com/slackapi/bolt-python-template.git
# Change into this project directory
cd bolt-python-starter-template
# Setup your python virtual environment
python3 -m venv .venv
source .venv/bin/activate
# Install the dependencies
pip install -r requirements.txt
# Start your local server
python3 app.py
```
#### Linting
```zsh
# Run flake8 from root directory for linting
flake8 *.py && flake8 listeners/
# Run black from root directory for code formatting
black .
```
## 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.py`
`app.py` 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.py` 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
```