https://github.com/xBytez/slackbotapi

node.js Slack RTM API module
https://github.com/xBytez/slackbotapi

hacktoberfest rtm slack slackbot slackbotapi

Last synced: 4 months ago
JSON representation

node.js Slack RTM API module

• Host: GitHub
• URL: https://github.com/xBytez/slackbotapi
• Owner: xBytez
• License: lgpl-3.0
• Created: 2014-12-14T17:02:03.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T00:35:26.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T13:20:38.963Z (10 months ago)
• Topics: hacktoberfest, rtm, slack, slackbot, slackbotapi
• Language: JavaScript
• Homepage:
• Size: 313 KB
• Stars: 136
• Watchers: 8
• Forks: 40
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



SlackbotAPI

============

[![GitHub Stars](https://img.shields.io/github/stars/xBytez/slackbotapi.svg)](https://github.com/xBytez/slackbotapi/stargazers)

[![GitHub Issues](https://img.shields.io/github/issues/xBytez/slackbotapi.svg)](https://github.com/xBytez/slackbotapi/issues)

[![Current Version](https://img.shields.io/npm/v/slackbotapi.svg)](https://github.com/xBytez/slackbotapi)

[![Documentation Coverage](http://inch-ci.org/github/xBytez/slackbotapi.svg?branch=master)](http://inch-ci.org/github/xBytez/slackbotapi)

[![Code Climate](https://codeclimate.com/github/xBytez/slackbotapi/badges/gpa.svg)](https://codeclimate.com/github/xBytez/slackbotapi)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/xBytez/slackbotapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

A Node.JS module for Slack's RTM API

---

## Setup

#### Requirements

>The following resources are needed in order to run `slackbotapi`:

 * Modules: `eventemitter3`, `jethro`, `request` and `ws`

 * A valid Slack API Token

#### Installation

Installing slackbotapi is as simple as running the following command:

```npm install slackbotapi```

---

## Usage

After installing this module and its [dependencies](#Requirements), you can check the [example_bot.js](https://github.com/xBytez/slackbotapi/blob/master/examples/example_bot.js) to learn the basics.

---

## Cool projects built on slackbotapi

 * [Slackslime by @franciskim](https://github.com/franciskim/slackslime)

 * [Slackquizbot by @codebyfire](https://github.com/codebyfire/slackquizbot)

 * [Slackweatherbot by @franciskim](https://github.com/franciskim/Slackweatherbot)

 * [Slack-file-cleaner by @Ad237](https://github.com/Ad237/slack-file-cleaner)

If you want your project to be listed here, please let us know by creating an issue with the link to your project. Chances are we'll list it here!

---

## Contact us

You can join the #slackbotapi channel over at https://slack.radiant.dj. (If you are already registered you can find us at https://radiantdj.slack.com) If you prefer not to join yet another Slack team, feel free to join Gitter or post an issue.