https://github.com/slack-samples/bolt-js-getting-started-app
Getting Started Slack app using ⚡️ Bolt for JavaScript
https://github.com/slack-samples/bolt-js-getting-started-app
Last synced: about 1 year ago
JSON representation
Getting Started Slack app using ⚡️ Bolt for JavaScript
- Host: GitHub
- URL: https://github.com/slack-samples/bolt-js-getting-started-app
- Owner: slack-samples
- License: mit
- Created: 2020-08-27T21:50:17.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-09T00:40:45.000Z (over 1 year ago)
- Last Synced: 2025-03-24T16:49:55.267Z (about 1 year ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 57
- Watchers: 6
- Forks: 54
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started ⚡️ Bolt for JavaScript
> Slack app example from 📚 [Getting started with Bolt for JavaScript tutorial][1]
## Overview
This is a Slack app built with the [Bolt for JavaScript framework][2] that showcases
responding to events and interactive buttons.
## Running locally
### 0. Create a new Slack App
- Go to https://api.slack.com/apps
- Click **Create App**
- Choose a workspace
- Enter App Manifest using contents of `manifest.yaml`
- Click **Create**
Once the app is created click **Install to Workspace**
Then scroll down in Basic Info and click **Generate Token and Scopes** with both scopes
### 1. Setup environment variables
```zsh
# Replace with your bot and app token
export SLACK_BOT_TOKEN= # from the OAuth section
export SLACK_APP_TOKEN= # from the Basic Info App Token Section
```
### 2. Setup your local project
```zsh
# Clone this project onto your machine
git clone https://github.com/slackapi/bolt-js-getting-started-app.git
# Change into the project
cd bolt-js-getting-started-app/
# Install the dependencies
npm install
```
### 3. Start servers
```zsh
npm run start
```
### 4. Test
Go to the installed workspace and type **Hello** in a DM to your new bot. You can also type **Hello** in a channel where the bot is present
## Contributing
### Issues and questions
Found a bug or have a question about this project? We'd love to hear from you!
1. Browse to [slackapi/bolt-js/issues][4]
1. Create a new issue
1. Select the `[x] examples` category
See you there and thanks for helping to improve Bolt for everyone!
[1]: https://tools.slack.dev/bolt-js/getting-started
[2]: https://tools.slack.dev/bolt-js/
[3]: https://tools.slack.dev/bolt-js/getting-started/#setting-up-events
[4]: https://github.com/slackapi/bolt-js/issues/new/choose