https://github.com/matejmecka/assistantslack

a Assistant that should help you on Slack
https://github.com/matejmecka/assistantslack

bot botkit botkit-bots nodejs slack

Last synced: 7 days ago
JSON representation

a Assistant that should help you on Slack

• Host: GitHub
• URL: https://github.com/matejmecka/assistantslack
• Owner: MatejMecka
• License: mit
• Created: 2017-02-17T22:05:37.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T04:49:18.000Z (about 2 years ago)
• Last Synced: 2024-04-15T07:27:35.108Z (9 months ago)
• Topics: bot, botkit, botkit-bots, nodejs, slack
• Language: JavaScript
• Homepage:
• Size: 313 KB
• Stars: 25
• Watchers: 6
• Forks: 11
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

# Assistant for Slack [![Codacy Badge](https://api.codacy.com/project/badge/Grade/4476f9276d914b6fb3c27afc3d284aeb)](https://www.codacy.com/app/matej.plavevski-github/AssistantSlack?utm_source=github.com&utm_medium=referral&utm_content=MatejMecka/AssistantSlack&utm_campaign=Badge_Grade) [![Join the chat at https://gitter.im/AssistantSlack/Lobby](https://badges.gitter.im/AssistantSlack/Lobby.svg)](https://gitter.im/AssistantSlack/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A Assistant, but on Slack. It allows you to search Google, fetch the date, look up GIFs, and more. More features are in the works.

### Requirements:

 - Node.JS (preferably v6.0.0+)

 - Botkit

 - Request

 - Google Search Scraper

 - Oxford Dictionary API

### Installation:

`npm install`

### Getting Started:

#### Running Locally as a Custom Integration

 - Create a new custom integration in your Slack workspace

   https://api.slack.com/apps?new_app=1

 - Under the Add Features and Functionality section add a new bot

 - Give the bot a Display name and Default User name and complete by adding the new bot user

 - Under the Settings section, select Install App and install your new add to your workspace

 - After installation, the OAuth Tokens for Your Team is displayed.  Copy the bot user auth token (xoxb -)

 - Update the config.js file providing the bot user auth token

 - Start the Bot running locally via node

   `node bot.js`

 - Console output for running bot

  ```

  Initializing Botkit v0.6.3

  info: ** No persistent storage method specified! Data may be lost when process shuts down.

  info: ** API CALL: https://slack.com/api/rtm.connect

  notice: ** BOT ID: botname ...attempting to connect to RTM!

  notice: RTM websocket opened

 ```

 - Once running got to your Slack workspace, and click on your Bot under the Apps section

 - Say 'Hello' to the Bot and if configured correctly you should get the response 'Hey there! How can I help you?'

#### Other Services and APIs

  - You should register for an API KEY or access to the apis running the other services in order to make use of those commands

  - Update the config.js with your keys and information as necessary

### Known Issues:

 - Google Search Scraper gives 10 results instead of the results specified (fixed by modifying directly the module)

 - Captcha (make a VPN for the bot, connect via VPN, fill out captcha for latest search, try again)

 - Translation returns BAD_NETWORK or something like that (fixed by modifying directly the module)