Skip to content

Commit

Permalink
Merge pull request #1 from alexbelyeu/feat/readme_and_authorize_var
Browse files Browse the repository at this point in the history
Feat/readme and authorize var
  • Loading branch information
alexbelyeu authored Mar 1, 2018
2 parents 732ab35 + 0f35008 commit f273395
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
tapbox-7d491-firebase-adminsdk-ijkiy-6aca66d503.json
tapbox-7d491-firebase-adminsdk-ijkiy-6aca66d503.json
screenshots
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ Simply create a Slash Command, such as `/juke`, which accepts a track name (also

/juke Ramble On – Led Zeppelin
/juke Ramble On

<img src="screenshots/tapbox_test.gif" alt="GIF of how it works" width="800" height="500">

## Installation

### Slack Slash command

First you'll want to create your Slack Slash Command, which you can do by going to your [Slash Commands page](https://my.slack.com/services/new/bots).

{{Image for Slack}}
<img src="screenshots/slack_settings.jpg" alt="Slack's settings for Slack command" width="800" height="500">

During setup, have your slash command or outgoing webhook submit a POST to your app's `/store` endpoint, e.g. `https://app-name.herokuapp.com/store`.

Expand All @@ -27,7 +29,7 @@ If you want to post the song that was recently added, go to [Your Slack's app di

Head over to [Spotify's Developer Site](http://developer.spotify.com) and create a new Application. Make sure you add whatever slackbox's callback URI as a valid callback URI. If you're running locally, this will be `http://localhost:5000/callback` or on Heroku `https://app-name.herokuapp.com/callback`

{{Image for Spotify}}
<img src="screenshots/spotify_settings.jpg" alt="Spotify's Developer page" width="400" height="400">

Make a note of the `key`, `secret` and `callback URI` too, as you'll need these later as well.

Expand All @@ -41,7 +43,7 @@ If you create an app on Heroku for free, the app will go to sleep after 30 minut

To create a Firebase database, create an account for free, add project with same name as on Heroku, create a database, and then generate a private key to get your `Firebase service account key` JSON file. You will need this file in the root of your project as it contains the private key to your DB.

{{Image for Firebase}}
<img src="screenshots/firebase_settings.jpg" alt="Firebase DB settings" width="800" height="400">

#### Cron job

Expand Down
Binary file added screenshots/firebase_settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/slack_settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/spotify_settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/tapbox_test.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f273395

Please sign in to comment.