Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sivagao/slack-bot

sivaga's slack bot
https://github.com/sivagao/slack-bot

Last synced: 23 days ago
JSON representation

sivaga's slack bot

Awesome Lists containing this project

README 

        
## 编写 Dockerfile



## 开发步骤



* git clone

* 配置 slack 等

* 安装依赖如 youtube-dl 等



wget https://yt-dl.org/downloads/latest/youtube-dl -O ./bin/youtube-dl chmod +x

./bin/youtube-dl



# Botkit Starter Kit for Slack Bots



This repo contains everything you need to get started building a Slack bot with

[Botkit](https://botkit.ai) and [Botkit Studio](https://botkit.ai).



Botkit is designed to ease the process of designing and running useful, creative

bots that live inside messaging platforms. Bots are applications that can send

and receive messages, and in many cases, appear alongside their human

counterparts as users.



Some bots talk like people, others silently work in the background, while others

present interfaces much like modern mobile applications. Botkit gives developers

the necessary tools for building bots of any kind! It provides an

easy-to-understand interface for sending and receiving messages so that

developers can focus on creating novel applications and experiences instead of

dealing with API endpoints.



Our goal with Botkit is to make bot building easy, fun, and accessible to anyone

with the desire to create a future filled with talking machines!



If you are looking to create a bot on other platforms using Glitch, check out

the [Botkit project page](https://glitch.com/botkit).



### What's Included



* [Botkit core](https://github.com/howdyai/botkit/blob/master/docs/readme.md#developing-with-botkit) -

  a complete programming system for building conversational software

* [Botkit Studio API](https://github.com/howdyai/botkit/blob/master/docs/readme-studio.md#function-index) -

  additional APIs that extend Botkit with powerful tools and APIs

* [Pre-configured Express.js webserver](https://expressjs.com/) including:

  * A customizable "Install my Bot" homepage

  * Login and oauth endpoints that allow teams to install your bot

  * Webhook endpoints for communicating with platforms

* Sample skill modules that demonstrate various features of Botkit

* A customizable onboarding experience for new teams powered by Botkit Studio



### Getting Started



There are a myriad of methods you can use to set up an application on Slack,

here are some of your options:



#### Use Botkit Studio



[Botkit Studio](https://studio.botkit.ai/signup?code=slackglitch) is a set of

tools that adds capabilities to the open source Botkit library by offering

hosted GUI interfaces for script management and action trigger definition.



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.



#### Install Botkit



[Remix this project on Glitch](https://glitch.com/~botkit-slack)



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



Clone this repository using Git:



`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 your Slack Application



Once you have setup your Botkit development enviroment, the next thing you will

want to do is set up a new Slack application via the

[Slack developer portal](https://api.slack.com/). 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.



* We also have this [handy video walkthrough](https://youtu.be/us2zdf0vRz0) for

  setting up this project with Glitch.



Next, get a Botkit Studio token

[from your Botkit developer account](https://studio.botkit.ai/) if you have

decided to use Studio.



Update the `.env` file with your newly acquired tokens.



Launch your bot application by typing:



`node .`



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



Now comes the fun part of

[making your bot!](https://github.com/howdyai/botkit/blob/master/docs/readme.md#basic-usage)



### Extend This Starter kit



This starter kit 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.



}

```



Continue your journey to becoming a champion botmaster by

[reading the Botkit Studio SDK documentation here.](https://github.com/howdyai/botkit/blob/master/docs/readme-studio.md)



### 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/docs/readme-middlewares.md#storage-modules)

which can be enabled with just a few lines of code.



We have enabled our [Mongo middleware]() for starters in this project. To use

your own Mongo database, just fill out `MONGO_URI` in your `.env` file with the

appropriate information. For tips on reading and writing to storage,

[check out these medium posts](https://botkit.groovehq.com/knowledge_base/categories/build-a-bot)



# Developer & Support Community



You can find full documentation for Botkit on our

[GitHub page](https://github.com/howdyai/botkit/blob/master/readme.md). Botkit

Studio users can access the

[Botkit Studio Knowledge Base](https://botkit.groovehq.com/help_center) for help

in managing their account.



### Need more help?



* Glitch allows users to ask the community for help directly from the editor!

  For more information on raising your hand,

  [read this blog post.](https://medium.com/glitch/just-raise-your-hand-how-glitch-helps-aa6564cb1685)



* Join our thriving community of Botkit developers and bot enthusiasts at large.

  Over 4500 members strong, [our open Slack group](http://community.botkit.ai)

  is _the place_ for people interested in the art and science of making bots.



Come to ask questions, share your progress, and commune with your peers!



* We also host a

  [regular meetup and annual conference called TALKABOT.](http://talkabot.ai)

  Come meet and learn from other bot developers!



[Full video of our 2016 event is available on Youtube.](https://www.youtube.com/playlist?list=PLD3JNfKLDs7WsEHSal2cfwG0Fex7A6aok)



# About Botkit



Botkit is a product of [Howdy](https://howdy.ai) and made in Austin, TX with the

help of a worldwide community of botheads.