Skip to content

Commit cc8c98d

Browse files
committed
docs: highlight .env.sample in readme
1 parent f134b55 commit cc8c98d

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,25 @@ Join the [Slack Developer Program](https://api.slack.com/developer-program) for
1717
4. Review the configuration and click *Create*
1818
5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard.
1919

20-
#### Environment Variables
20+
### Environment Variables
21+
2122
Before you can run the app, you'll need to store some environment variables.
2223

23-
1. Open your app 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`.
24-
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`.
2524

25+
1. Rename `.env.sample` to `.env`.
26+
2. Open your apps setting page from [this list](https://api.slack.com/apps), click _OAuth & Permissions_ in the left hand menu, then copy the _Bot User OAuth Token_ into your `.env` file under `SLACK_BOT_TOKEN`.
27+
```zsh
28+
SLACK_BOT_TOKEN=YOUR_SLACK_BOT_TOKEN
29+
```
30+
3. 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 that token into your `.env` as `SLACK_APP_TOKEN`.
2631
```zsh
27-
# Replace with your app token and bot token
28-
# For Windows OS, env:SLACK_BOT_TOKEN = <your-bot-token> works
29-
export SLACK_BOT_TOKEN=<your-bot-token>
30-
export SLACK_APP_TOKEN=<your-app-token>
31-
# This sample uses OpenAI's API by default, but you can switch to any other solution!
32-
export OPENAI_API_KEY=<your-openai-api-key>
32+
SLACK_APP_TOKEN=YOUR_SLACK_APP_TOKEN
3333
```
34+
4. Save your OpenAI key into `.env` under `OPENAI_API_KEY`.
35+
```zsh
36+
OPENAI_API_KEY=YOUR_OPEN_API_KEY
37+
```
38+
3439

3540
### Setup Your Local Project
3641
```zsh

0 commit comments

Comments
 (0)