Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joemcmahon/mrspiral-spudtest

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/joemcmahon/mrspiral-spudtest
Owner: joemcmahon
License: mit
Created: 2017-09-22T22:50:42.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-09-23T00:03:36.000Z (over 7 years ago)
Last Synced: 2024-10-28T15:48:15.108Z (about 2 months ago)
Language: JavaScript
Size: 1.34 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # starter-slapp-app

This repository is meant as an example and starting point for building a Slack app on [Beep Boop][bb].  It's written in [node.js](), uses the [Slapp][slapp] library, and takes advantage of the [Slack Events API][slack-events-api].

## Setup Instructions

Once you've created a new [Beep Boop](bb) project with this repo, go to your project's **Settings** tab and enable a Slack App.

![Enable Slack App](https://cloud.githubusercontent.com/assets/367275/19362140/b4039c86-9142-11e6-9b31-941609c1b090.gif)

Follow the steps laid out in the wizard. You'll want to enable **Event Subscriptions** on your Slack App using the `URL` provided and add subscriptions for the following **Bot Events**:

+ `message.channels`

+ `message.im`

### 🔥 it up

Once you've finished setting up your Slack App and saved the `Client ID`, `Client Secret` and `Verification Token` on Beep Boop, go ahead and **Start** your project.

![Start](https://cloud.githubusercontent.com/assets/367275/19364564/edb43efa-914b-11e6-9265-d33122bf5f9a.png)

Once your project has started, go to the **Teams** tab and add your new Slack App to one of your Slack teams.

![Add Team](https://cloud.githubusercontent.com/assets/367275/19364343/012e4922-914b-11e6-8f0a-bb020b016fd2.png)

Send `@slappbot` a Direct Message of `help` to see what it can do.

![Help](https://cloud.githubusercontent.com/assets/367275/19364707/7a4f8964-914c-11e6-99cd-d4cd65c9061a.png)

### Why is my Bot Offline?

![Bot Offline](https://cloud.githubusercontent.com/assets/367275/19364857/3944ba24-914d-11e6-9939-a37ed07b954e.png)

Your bot will not show as "online", which is a current limitation of the [Slack Events API][slack-events-api] (no way to set presence). If you really want your bot to show online, [check out this work-around][presence-polyfill].

[bb]: https://beepboophq.com

[slapp]: https://github.com/BeepBoopHQ/slapp

[slack-events-api]: https://api.slack.com/events-api

[presence-polyfill]: https://github.com/BeepBoopHQ/beepboop-slapp-presence-polyfill