Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 3.9 KB

README.md

File metadata and controls

93 lines (58 loc) · 3.9 KB
Raw

Fabulous Bot for Slack

Fabulous Bot for Slack

GitHub license GitHub stars GitHub forks GitHub issues

Donate ($1) - Help us in creating more awesome open source projects

Never leave your Slack again!

Fabulous Bot is a bot which does the basic work of searching from different platforms and showing the results directly in your Slack channel. Users don’t have to leave Slack, open browser and search for something.

User will be able to

  • search from Google, Wikipedia, YouTube etc—( top 3 results will be shown)
  • Check weather of any city
  • Search Query from Stack Overflow
  • Get commits data of any repository, Branch or pull request
  • Get stocks data
  • Search images from Google Images, Flickr etc
  • Do mathematical Calculations
  • Check meaning of words — From Urban Dictionary
  • View maps
  • and will be able to perform lot more tasks.

Read the full article here.

Goal?

We are currently buidling this. If you would like to hear about our first beta release, please leave your email here.

Fabulous

Installation

Steps to Run this Bot Locally!

  • clone the repo
  • Do export SLACK_TOKEN='slack-api-token'
  • edit the Makefile and add sudo to the run, repl section and sudo -H in requirements section
  • then make repl for local testing
  • if make repl doesn't work, try with sudo
  • Work on services folder only
  • Check gif service for the reference.

Note: for windows, edit Makefile and remove all instances of sudo and sudo -H

Enabling different service

  • Few services in fabulous rely on external services like google distance, search etc. to be use these services users will need to get their api key from these service providers and save them into a file from which fabulous can read the api keys.
  • To Enable Direction service save your google direction api to fabulous/services/secret_example file inside the GOOGLE_DIRECTION_API variable.
  • To Enable finance service save your api key to secret_example file inside the ALPHA_VANTAGE_STOCK_API variable.
  • TO Enable google search service save your google search api key and google CSE into secret_example file inside GOOGLE_SEARCH_API and GOOGLE_CUSTOM_SEARCH_ENGINE variables.
  • To Enable news service save your newsapi.org news api key to secret_example file inside NEWS_APIvariable.

Running in a Docker contianer!

  • Clone the repo
  • run cd fabulous && docker build -t faboulous . && docker run -it fabulous

Running the TestSuite

  • run make test

Getting Started

Please read this article on Fabulous Bot

Contributing

Please read our Contributing to Eulercoder Projects Wiki.

Issues

Check Issue tracker for all the issues.

Licence

GPL-V3 Licence (c) Eulercoder Technologies & vicky002

Built with ❤️ in python and Eulercoder