Skip to content

Commit 2d30931

Browse files
committed
docs: Updated get started docs
1 parent bfa5487 commit 2d30931

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
11
# HackerRank Queue Slack Bot
22

3-
```bash
4-
# Install dependencies
5-
yarn install
6-
7-
# Create and fill out .env file (See "Env Variables" link)
8-
touch .env
3+
## Development
94

10-
# Start the app locally
11-
yarn start
12-
```
5+
Make sure to have the following tools installed:
136

14-
> When filling out the `GOOGLE_PRIVATE_KEY` env variable in your `.env` file, put it all on a single line by replacing newlines with `\n`
7+
- `nvm` (optional)
8+
- `node v14.15.5`
9+
- `yarn`
10+
- Heroku CLI
1511

16-
## Development
12+
You will never have to run the code locally, other than to run tests.
1713

18-
Development is kinda weird since Slack wants a public URL to work off of. Because there isn't a "prod" yet, I've just been deploying each change to Heroku, then testing in Slack.
14+
To manually test out changes, you'll simply deploy to Heroku and actually use the bot in slack!
1915

2016
```bash
17+
# Install dependencies
18+
yarn install
19+
2120
# Login to Heroku CLI - only have to do this once
2221
yarn docker:login
2322

2423
# Deploy the app after making changes
2524
yarn docker:deploy
2625
```
2726

28-
<br/>
27+
> You don't have to commit anything before doing a deploy. Just make the change and deploy
2928
3029
### Useful links
3130

3231
- Slack App Config: <https://api.slack.com/apps/A01TFKZKPT7/general>
3332
- Heroku App: <https://dashboard.heroku.com/apps/hacker-rank-queue>
34-
- Env Variables: <https://dashboard.heroku.com/apps/hacker-rank-queue/settings>
35-
- Database Spreadsheet: <https://docs.google.com/spreadsheets/d/1ChOEjl5l_Uh5dTd_fRjGJt8z7bFNNOwPlzgRnhOLgTY/edit?usp=sharing>
33+
- Spreadsheet Databases: <https://drive.google.com/drive/folders/1bCO8LllRNpysu65WOjBsUAZUnrDqXDX0?usp=sharing>

0 commit comments

Comments
 (0)