https://github.com/jonchurch/botkit-threading

Botkit threading test project
https://github.com/jonchurch/botkit-threading

Last synced: 22 days ago
JSON representation

Botkit threading test project

• Host: GitHub
• URL: https://github.com/jonchurch/botkit-threading
• Owner: jonchurch
• Created: 2017-01-19T19:17:58.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-19T19:24:23.000Z (almost 8 years ago)
• Last Synced: 2024-10-05T14:40:38.419Z (3 months ago)
• Language: JavaScript
• Size: 60.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Botkit Starter Kit for Slack Bots

This repo contains everything you need to get started building a bot with Botkit and Botkit Studio!

[Botkit Studio](https://studio.botkit.ai/) 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.](https://howdy.ai)

While Botkit Studio is *not required* to build a bot using Botkit, we highly recommend it as your bot will be easier to manage, customize and extend.

### Instant Start

[Remix this project on Gomix](https://gomix.com/#!/project/botkit-slack)

[Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/howdyai/botkit-starter-slack/master)

### Get Started

Clone this repository:

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

Install dependencies, including [Botkit](https://github.com/howdyai/botkit):

```

cd botkit-starter-slack

npm install

```

Set up a new Slack application via the Slack developer portal. This is a multi-step process, but only takes a few minutes. [Read this step-by-step guide](https://github.com/howdyai/botkit/blob/master/docs/slack-events-api.md) to make sure everything is set up.

Next, get a Botkit Studio token [from your Botkit developer account](https://studio.botkit.ai/)

Now, run your bot from the command line with your new tokens:

`clientId= clientSecret= PORT=<3000> studio_token= node bot.js`

Now, visit your new bot's login page: http://localhost:3000/login

Once successfully logged in, 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.](https://github.com/howdyai/botkit/blob/master/readme-studio.md)

### 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.

}

```

### Customize Storage

By default, the starter kit uses a simple file-system based storage mechanism to

record information about the teams and users that interact with the bot. While

this is fine for development, or use by a single team, most developers will want

to customize the code to use a real database system.

There are [Botkit plugins for all the major database systems](https://github.com/howdyai/botkit/blob/master/readme-middlewares.md#storage-modules) which can be enabled with just a few lines of code.