Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himenon/template-slack-bolt
Slack App template to be created with slack bolt. This sample uses Socket Mode to retrieve messages.
https://github.com/himenon/template-slack-bolt
bolt slack socket
Last synced: 2 days ago
JSON representation
Slack App template to be created with slack bolt. This sample uses Socket Mode to retrieve messages.
- Host: GitHub
- URL: https://github.com/himenon/template-slack-bolt
- Owner: Himenon
- License: mit
- Created: 2022-06-06T15:01:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-08T08:28:23.000Z (over 2 years ago)
- Last Synced: 2024-10-11T20:59:34.785Z (27 days ago)
- Topics: bolt, slack, socket
- Language: TypeScript
- Homepage:
- Size: 1.37 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @himenon/template-slack-bolt
Slack App template to be created with slack bolt.
This sample uses [Socket Mode](https://api.slack.com/apis/connections/socket) to retrieve messages.
## Development
- [Set Slack App](./SETUP_SLACK_APP.md)
**Install**
```bash
pnpm install
```
**Watch**
```bash
pnpm watch
```
**Build**
```bash
pnpm build
```
**Build Docker Image**
```bash
docker build . -t ghcr.io/himenon/template-slack-bolt:local
```
**Docker Run**
```bash
docker run --rm --env-file=.env.production ghcr.io/himenon/template-slack-bolt:local
docker compose up
# Deamon
docker run --rm --env-file=.env.production -d ghcr.io/himenon/template-slack-bolt:local
docker compose up -d
```
### Environment File
`.env`
```
VERSION=1.0.1
```
`.env.production`
```
SLACK_APP_TOKEN=xapp-****
SLACK_BOT_TOKEN=xoxb-****
```
## Architecture
**Basic**
```mermaid
sequenceDiagram
slack.com->>Slack App : Message vis Socket Mode
Slack App-->>Subscriber : Send Parsed Message
Subscriber-->>Function : Run Function
Function-->>Subscriber : Response
Subscriber-->>slack.com : Send Message
```
| Name | FileName |
| :--------- | :--------------------------------- |
| slack.com | - |
| Slack App | `src/slack/server.ts` |
| Subscriber | `src/subscriber/index.ts` |
| Function | `src/subscriber/index.ts` (Method) |
## Release
- Automatic version updates are performed when merged into the `main` branch.
## License
[@himenon/template-slack-bolt](https://github.com/Himenon/template-slack-bolt)・MIT