Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update README.md #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samcorky merged 2 commits into from
Mar 26, 2025
+11 −0
Merged

Update README.md #299

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28a493b
Update README.md
samcorky Mar 26, 2025
b6bc0e9
Update README.md
samcorky Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ SMIB is the So Make It Bot. The architecture is a set of docker containers confi
- Stateful database storage for storing information like space state for coordination among multiple bots/endpoints.
- SMIBHID (SMIB Human Interface Device) - A Pi Pico based interface device that provides buttons, displays and any other human interface to the slack bot via the REST API. See the [SMIBHID docs](smibhid/README.md) for more information.

## Slack App Creation
- If you don't already have a Slack Workspace, [create one](https://slack.com/get-started?entry_point=help_center#/createnew).
- Follow the [Creating apps using manifests](https://api.slack.com/reference/manifests#creating_apps) instructions to create a Slack App from the included [manifest](manifest.yaml) and install it into your workspace.
- Once created, go to your [installed apps list](https://api.slack.com/apps) and select the newly installed app.
- Find the `App-Level Tokens` section of the page and click `Generate Token and Scopes`.
- Create a token with the `connections:write` scope. This allows SMIB to establish a Websocket connection to Slack.
- Make sure to copy this token, as this will be used as your `SLACK_APP_TOKEN` environment variable. This should start with `xapp-`
- On the side navigation panel, click the `OAuth and Permissions` button.
- You should find a pre-generated `Bot User OAuth Token` under the `OAuth Tokens` section of this page.
- Make sure to copy this token, as this will be used as your `SLACK_BOT_TOKEN` environment variable. This should start with `xapp-`

## Docker deployment
### Supported Python Version
Python 3.12.3
Expand Down