Skip to content

Commit f5b475d

Browse files
authored
Create README.md
1 parent 3af530a commit f5b475d

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Getting Started with ⚡️ Bolt for JavaScript
2+
> Slack app example from 📚 [Getting started with Bolt for JavaScript tutorial][1]
3+
4+
## Overview
5+
6+
This is a Slack app built with the [Bolt for JavaScript framework][2] that showcases
7+
responding to events and interactive buttons.
8+
9+
## Running locally
10+
11+
### 1. Setup environment variables
12+
13+
```zsh
14+
# Replace with your signing secret and token
15+
export SLACK_APP_BOLT_JS_GETTING_STARTED_SIGNING_SECRET=abcd1234567890123456789012345678
16+
export SLACK_APP_BOLT_JS_GETTING_STARTED_TOKEN=xoxb-123456789012-123456789012-abcd12345678901234567890
17+
```
18+
19+
### 2. Setup your local project
20+
21+
```zsh
22+
# Clone this project onto your machine
23+
git clone https://github.com/mwbrooks/bolt-js-getting-started-app.git
24+
25+
# Change into the project
26+
cd bolt-js-getting-started-app/
27+
28+
# Install the dependencies
29+
npm install
30+
```
31+
32+
### 3. Start servers
33+
34+
```zsh
35+
npm run ngrok
36+
npm run start
37+
```
38+
39+
[1]: https://slack.dev/bolt-js/tutorial/getting-started
40+
[2]: https://slack.dev/bolt-js/

0 commit comments

Comments
 (0)