Skip to content

Commit

Permalink
📚 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
raycharius committed Oct 3, 2021
1 parent 3cae139 commit b876046
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This Slack app can easily be added to your own workspace and used locally using
* Follow the [instructions laid out by Slack](https://api.slack.com/reference/manifests) to install an app via a manifest.
* Go into the app's *Basic Information* and click **Install to Workspace**.

### :wrench:   Add Tokens
### :wrench:   Adding The App Tokens

* Create a file called `.env` in the root of the repository.
* Copy over the contents of `.env.example` to the file.
Expand All @@ -35,5 +35,21 @@ This Slack app can easily be added to your own workspace and used locally using
* Click the **Generate Token and Scopes** button, give the token a name and create it, and copy the value to the clipboard.
* Paste that value to `APP_TOKEN` in the `.env` file.

### :whale:   Starting The App With Docker (Or Not)

There is a Docker file included in the repository, which is the recommended way of hosting the app locally:

* Make sure that Docker is installed
* In the terminal, make sure you are in the root of the project
* Execute the `docker-compose up` command
* The app should be up and running and ready to accept payloads from your workspace

For those who do not wish to use Docker, just execute `npm run start`.

### :partying_face:   Opening The Demo

* Open your Slack workspace
* Open any conversation or channel
* Use the `/block-builder` slash command to launch the app's main menu.
* Have fun!

0 comments on commit b876046

Please sign in to comment.