{"_id":"@abbott-platform/botkit","_rev":"1-86e059c3823056c705a1947a4c542b42","name":"@abbott-platform/botkit","description":"Building blocks for Building Bots","dist-tags":{"latest":"1.5.3"},"versions":{"1.5.3":{"name":"@abbott-platform/botkit","version":"1.5.3","description":"Building blocks for Building Bots","main":"lib/Botkit.js","dependencies":{"actions-on-google":"^1.1.1","async":"^2.1.5","back":"^1.0.1","body-parser":"^1.17.1","botbuilder":"^3.7.0","botkit-studio-sdk":"^1.0.2","ciscospark":"^1.1.6","clone":"2.1.1","command-line-args":"^4.0.2","crypto":"0.0.3","express":"^4.15.2","https-proxy-agent":"^2.0.0","jfs":"^0.2.6","localtunnel":"^1.8.2","md5":"^2.2.1","mustache":"^2.3.0","promise":"^8.0.0","request":"^2.81.0","twilio":"^2.11.1","ware":"^1.3.0","ws":"^2.2.2"},"devDependencies":{"jest-cli":"^20.0.4","jscs":"^3.0.7","mocha":"^3.2.0","should":"^11.2.1","should-sinon":"0.0.5","sinon":"^2.1.0","winston":"^2.3.1"},"scripts":{"pretest":"jscs ./lib/ ./__test__ --fix","test":"jest --coverage","test-legacy":"mocha ./tests/*.js","test-watch":"jest --watch","publish":"npm publish --access public"},"repository":{"type":"git","url":"git+https://github.com/howdyai/botkit.git"},"bugs":{"url":"https://github.com/howdyai/botkit/issues"},"homepage":"http://howdy.ai/botkit","keywords":["bots","chatbots","slack","cisco spark","facebook messenger","twilio ipm","microsoft bot framework"],"author":{"name":"ben@howdy.ai"},"license":"MIT","jest":{"testEnvironment":"node"},"gitHead":"0a0b5cc9bab3143ec9856757ae937291089fb079","_id":"@abbott-platform/botkit@1.5.3","_npmVersion":"5.3.0","_nodeVersion":"7.10.0","_npmUser":{"name":"patrinhani-ciandt","email":"patrinhani@ciandt.com"},"dist":{"integrity":"sha512-k5B5PyG71KwB88pXGXiLMtcudMi76oHHPE1mNO1VY4EoFbg1n44ov/NMPoyLrDW+22NSEgJKOr4TzyBaoPS0xQ==","shasum":"96601cf7e055d876392dd2641120744829aa5420","tarball":"https://registry.npmjs.org/@abbott-platform/botkit/-/botkit-1.5.3.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC/sucItZTIh1Wzan9QxLusuAsRS9gTWJqsVExdQ+qpigIgIZqkuWxUz7UVGXQi49RXM2t337xK26JjNj+Pg/bfRVM="}]},"maintainers":[{"name":"patrinhani-ciandt","email":"patrinhani@ciandt.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/botkit-1.5.3.tgz_1505752005956_0.7800254374742508"}}},"readme":"# [Botkit](https://botkit.ai) - Building Blocks for Building Bots\n\n[![npm](https://img.shields.io/npm/v/botkit.svg)](https://www.npmjs.com/package/botkit)\n[![David](https://img.shields.io/david/howdyai/botkit.svg)](https://david-dm.org/howdyai/botkit)\n[![npm](https://img.shields.io/npm/l/botkit.svg)](https://spdx.org/licenses/MIT)\n[![bitHound Overall Score](https://www.bithound.io/github/howdyai/botkit/badges/score.svg)](https://www.bithound.io/github/howdyai/botkit)\n\nBotkit is designed to ease the process of designing and running useful, creative bots that live inside messaging platforms.\nBots are applications that can send and receive messages, and in many cases, appear alongside their human counterparts as _users._\n\nSome bots talk like people, others silently work in the background, while others present interfaces much like modern mobile applications.\nBotkit 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.\n\nOur goal with Botkit is to make bot building easy, fun, and accessible to anyone with the desire to create\na future filled with talking machines! We provide several tools to make this vision a reality:\n\n* [Botkit Studio](#start-with-botkit-studio), an integrated development environment for designing and building bots\n* [Starter Kits](#start-with-a-starter-kit), boilerplate applications pre-configured to work with popular platforms\n* [Botkit Core Library](#botkit-core-library), an SDK for creating conversational software\n* [Plugins and Middlewares](docs/readme-middlewares.md) that can extend and enhance your bot\n\nBotkit features a comprehensive set of tools to deal with popular messaging platforms, including:\n\n* [Slack](docs/readme-slack.md)\n* [Cisco Spark](docs/readme-ciscospark.md)\n* [Facebook Messenger and Facebook @Workplace](docs/readme-facebook.md)\n* [Twilio SMS Messaging](docs/readme-twiliosms.md)\n* [Twilio IP Messaging](docs/readme-twilioipm.md)\n* [Microsoft Bot Framework](docs/readme-botframework.md)\n* Yours? [info@howdy.ai](mailto:info@howdy.ai)\n\n---\n\n## [Start with Botkit Studio](https://studio.botkit.ai/signup)\n\nBotkit Studio is a hosted development environment for building bots with Botkit.\nDevelopers using Botkit Studio get the full capabilities of Botkit, with the addition of many powerful bot-building features such as:\n\n* All the code you need to get your bot online in minutes\n* A visual authoring environment for designing and managing dialog\n* A real-time message console for monitoring activity\n* APIs that enable content and features to be added to bots without additional code\n* Role-based, multi-user teams support\n* Detailed usage statistics\n* Built-in integrations with top plugins and platform tools\n\nClick below to sign up for a free developer account, [and please contact us if you have any questions.](mailto:info@howdy.ai)\n\n**[![Sign up for Botkit Studio](docs/studio.png)](https://studio.botkit.ai/signup?code=readme)**\n\n\n## Start with a Starter Kit\n\nBased on the best practices we've established since the release of Botkit, our starter kits include\neverything you need to bring a Botkit bot online in minutes. Don't start from scratch -- start with a\nwell structured, extensible application boilerplate!\n\nThese starter kits are easy to set up and run on your own hosting service, but the fastest (and cheapest) way to get\nstarted is to deploy directly to [Glitch](http://glitch.com), a free-to-use code editor and hosting system!\n\nNote: While [using Botkit Studio](https://studio.botkit.ai) is highly recommended, these starter kits can be used without registering for Studio as well.\n\n> ### [Slack Bot Starter Kit](https://github.com/howdyai/botkit-starter-slack)\n> The Slack starter kit contains everything you need to create a multi-team Slack application,\nsuitable for internal use or submission to [Slack's app store.](https://slack.com/apps)\n> #### [![Remix on Glitch](docs/glitch.png)](https://glitch.com/edit/#!/import/github/howdyai/botkit-starter-slack)\n\n> ### [Cisco Spark Bot Starter Kit](https://github.com/howdyai/botkit-starter-ciscospark)\n> Build a bot inside Cisco Spark's collaboration and messaging platform. Bots built with the starter kit\nare ready to submit to [Cisco Spark's Depot app store](https://depot.ciscospark.com/).\n> #### [![Remix on Glitch](docs/glitch.png)](https://glitch.com/edit/#!/import/github/howdyai/botkit-starter-ciscospark)\n\n> ### [Facebook Bot Starter Kit](https://github.com/howdyai/botkit-starter-facebook)\n> The Facebook starter kit contains all the code necessary to stand up a Facebook bot on either Facebook Messenger, or Facebook Work Chat. With just a few pieces of configuration, set up a bot that automatically responds to messages sent to your Facebook page.\n> #### [![Remix on Glitch](docs/glitch.png)](https://glitch.com/edit/#!/import/github/howdyai/botkit-starter-facebook)\n\n# Developer & Support Community\n\nJoin our thriving community of Botkit developers and bot enthusiasts at large.\nOver 4500 members strong, [our open Slack group](http://community.botkit.ai) is\n_the place_ for people interested in the art and science of making bots.\nCome to ask questions, share your progress, and commune with your peers!\n\nYou can also find help from members of the Botkit team [in our dedicated Cisco Spark room](https://eurl.io/#SyNZuomKx)!\n\nWe also host a [regular meetup and annual conference called TALKABOT.](http://talkabot.ai)\nCome meet and learn from other bot developers! [Full video of our 2016 event is available on Youtube.](https://www.youtube.com/playlist?list=PLD3JNfKLDs7WsEHSal2cfwG0Fex7A6aok)\n\n\n\n# Botkit Core Library\n\nBotkit is designed around the idea of giving developers a language-like interface for building bots.\nInstead of dealing directly with messaging platform protocols and APIs, Botkit provides semantic functions\ndesigned around the normal parts of human conversation: _hearing things_ and _saying things_.\n\nOn top of these basic build blocks, Botkit offers a powerful system for creating and managing dynamic\nconversational interfaces, and tapping into cutting edge technology like artificial intelligence (AI)\nand natural language understanding (NLP/NLU) tools.\n\nPractically speaking, this results in code that looks like this:\n\n```javascript\n// respond when a user sends a DM to the bot that says \"hello\"\ncontroller.hears('hello', 'direct_message', function(bot, message) {\n    bot.reply(message, 'Hello human.');\n});\n```\n\nAll Botkit bots, built for any platform, use these same building blocks. This means developers are not required\nto learn the intricacies of each platform, and can build bots that port easily between them.\n\nBotkit can be used to build a stand-alone application, or it can be integrated into existing Node.js\napps to offer a bot experience, or to send application notifications into messaging apps. It is released\nunder the [MIT open source license](LICENSE.md), which means developers are free to use it any way they choose,\nin any type of project.\n\n\n## Install Botkit from NPM or Github\n\nBotkit is available via NPM.\n\n```bash\nnpm install --save botkit\n```\n\nYou can also check out Botkit directly from Git.\nIf you want to use the example code and included bots, it may be preferable to use Github over NPM.\n\n```bash\ngit clone git@github.com:howdyai/botkit.git\n```\n\nAfter cloning the Git repository, you have to install the node dependencies. Navigate to the root of your cloned repository and use npm to install all necessary dependencies.\n```bash\nnpm install\n```\n\nUse the `--production` flag to skip the installation of devDependencies from Botkit. Useful if you just wish to run the example bot.\n```bash\nnpm install --production\n```\n\n## Running Tests\n\nTo run tests, use the npm `test` command. Note: you will need dev dependencies installed using `npm install`.\n\n```bash\nnpm test\n```\n\nTo run tests in watch mode run:\n\n```bash\nnpm run test-watch\n```\n\nTests are run with [Jest](https://facebook.github.io/jest/docs/getting-started.html). You can pass Jest command line options after a `--`.\nFor example to have Jest bail on the first error you can run\n\n```bash\nnpm test -- --bail\n```\n\n## Documentation\n\n* [Get Started](docs/readme.md)\n* [Botkit Studio API](docs/readme-studio.md)\n* [Function index](docs/readme.md#developing-with-botkit)\n* [Extending Botkit with Plugins and Middleware](docs/middleware.md)\n  * [List of current plugins](docs/readme-middlewares.md)\n* [Storing Information](docs/storage.md)\n* [Logging](docs/logging.md)\n* Platforms\n  * [Slack](docs/readme-slack.md)\n  * [Cisco Spark](docs/readme-ciscospark.md)\n  * [Facebook Messenger](docs/readme-facebook.md)\n  * [Twilio SMS](docs/readme-twiliosms.md)\n  * [Twilio IPM](docs/readme-twilioipm.md)\n  * [Microsoft Bot Framework](docs/readme-botframework.md)\n* Contributing to Botkit\n  * [Contributing to Botkit Core](CONTRIBUTING.md)\n  * [Building Middleware/plugins](docs/howto/build_middleware.md)\n  * [Building platform connectors](docs/howto/build_connector.md)\n\n# About Botkit\n\nBotkit is a product of [Howdy](https://howdy.ai).\n\nFor support, check out [the Developer Community](#developer--support-community) and find our team in the #Botkit channel.\n","maintainers":[{"name":"patrinhani-ciandt","email":"patrinhani@ciandt.com"}],"time":{"modified":"2022-04-04T10:57:12.392Z","created":"2017-09-18T16:26:46.228Z","1.5.3":"2017-09-18T16:26:46.228Z"},"homepage":"http://howdy.ai/botkit","keywords":["bots","chatbots","slack","cisco spark","facebook messenger","twilio ipm","microsoft bot framework"],"repository":{"type":"git","url":"git+https://github.com/howdyai/botkit.git"},"author":{"name":"ben@howdy.ai"},"bugs":{"url":"https://github.com/howdyai/botkit/issues"},"license":"MIT","readmeFilename":"readme.md"}