Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

A starter kit for building bots with Botkit and the Slack RTM api

Notifications You must be signed in to change notification settings

howdyai/botkit-starter-slackrtm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Botkit Studio Starter Kit

This repo contains everything you need to get started building a bot using Slack's RTM API and Botkit!


Before you begin: we highly recommend that new bot developers start with our new starter kit which uses the more modern Slack Events API, as is thus more feature rich and easier to manage.


Botkit Studio is a set tools that adds capabilities to the open source Botkit library by offering hosted GUI interfaces for script management and action trigger definition. Botkit Studio is built by the company that created and maintains the open source Botkit library, Howdy.

Get Started

Clone this repository:

git clone https://github.com/howdyai/botkit-starter-slackrtm.git

Install dependencies, including Botkit:

cd botkit-starter-slackrtm
npm install

Get a Slack bot token from your Slack team

Get a Botkit Studio token from your Botkit developer account

Run your bot from the command line with your new tokens:

token=<slack token> studio_token=<botkit studio token> node .

Your bot should connect to Slack AND Botkit Studio and leap into action!

Continue your journey to becoming a champion botmaster by reading the Botkit Studio SDK documentation here.

Extend This Bot

This repo is designed to provide developers a robust starting point for building a custom bot. Included in the code are a set of sample bot "skills" that illustrate various aspects of the Botkit SDK features. Once you are familiar with how Botkit works, you may safely delete all of the files in the skills/ subfolder.

Developers will build custom features as modules that live in the skills/ folder. The main bot application will automatically include any files placed there.

A skill module should be in the format:

module.exports = function(controller) {

    // add event handlers to controller
    // such as hears handlers that match triggers defined in code
    // or controller.studio.before, validate, and after which tie into triggers
    // defined in the Botkit Studio UI.

}

About

A starter kit for building bots with Botkit and the Slack RTM api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published