Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricardovaltierra/slackbot
Slackbot to interact on a given workspace and make questions like current weather, locations, and jokes.
https://github.com/ricardovaltierra/slackbot
Last synced: 16 days ago
JSON representation
Slackbot to interact on a given workspace and make questions like current weather, locations, and jokes.
- Host: GitHub
- URL: https://github.com/ricardovaltierra/slackbot
- Owner: ricardovaltierra
- License: mit
- Created: 2020-01-07T22:10:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T00:51:00.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T02:01:54.253Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 6.77 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slackbot
> Microverse Ruby Capstone Project.
Explore the repo »
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Preview](#preview)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [How it Works](#how-it-works)
* [Contributing](#contributing)
* [Contact](#contact)
* [MIT License](#mit-license)
## About The Project
Slack bot developed on official Wolfram and Slack API's resources to interact on a given workspace and make questions like weather, location places, and more.
It allows you to make a quick web query by asking your bot without leaving Slack.
## Preview
Feel free to use and recommend it.
## Built With
* [Ruby =< 2.6.5](https://www.ruby-lang.org/en/)
* [YAML](https://yaml.org/)
* [Slack-Ruby-Bot](https://github.com/slack-ruby/slack-ruby-bot#slack-ruby-bot)
* [Slack API](http://api.slack.com)
* [Wolfram API](https://account.wolfram.com/auth/sign-in)
## Getting Started
To get a local copy up and running follow these simple steps.
Clone or fork the repo [[email protected]:ricardovaltierra/slackbot.git].
## How it Works
### Step 1: Clone and install dependencies
Clone the repo and run `bundle install` to get all the gems on your terminal.
### Step 2: Get your tokens for Slack & Wolfram APIs
You will have to register on [WolframID](http://account.wolfram.com/wolframid) and [Slack Bot Integration](http://slack.com/services/new/bot) to get your access tokens (for a register tutorial on Slack and Wolfram click [here](TUTORIAL.md)). Once that done just paste on your `.env` file.
### Step 3: Add your bot to a channel and run
You're almost done with code part. Now just execute with `rackup` and have fun! Above are some examples, but feel free to see description of each command with '@your_bot's_name are you there?' or '@your_bot's_name help'.
Also feel free to play with the code for some commands, like changing responses or adding them on `bot.rb`.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project.
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the Branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.
## Contact
Ricardo Valtierra - [@RicardoValtie15](https://twitter.com/RicardoValtie15) - [email protected] - [linkedin.com/in/ricardovaltierra/](https://www.linkedin.com/in/ricardovaltierra/)
## MIT License
This project is under the [MIT](LICENSE) license.