botnaut
Version:
Facebook Messenger Chatbot Framework
952 lines (402 loc) • 26.6 kB
HTML
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Getting Started · Botnaut</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<meta name="author" content="David Menger">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-anchors/plugin.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="tutorial/buildingConversation.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Building a chat bot</li>
<li class="chapter active" data-level="1.1" data-path="./">
<a href="./">
Getting Started
</a>
</li>
<li class="chapter " data-level="1.2" data-path="tutorial/buildingConversation.html">
<a href="tutorial/buildingConversation.html">
Building a Conversation
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="tutorial/buildingConversation.html">
<a href="tutorial/buildingConversation.html#asking-a-question">
Asking a question
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="tutorial/buildingConversation.html">
<a href="tutorial/buildingConversation.html#using-quick-replies-for-controlling-conversation">
Using quick replies
</a>
</li>
<li class="chapter " data-level="1.2.3" data-path="tutorial/buildingConversation.html">
<a href="tutorial/buildingConversation.html#post-back-is-also-an-action">
Postbacks
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="tutorial/conversationState.html">
<a href="tutorial/conversationState.html">
Conversation State
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="tutorial/conversationState.html">
<a href="tutorial/conversationState.html#accessing-user-profile">
User profile
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="tutorial/conversationState.html">
<a href="tutorial/conversationState.html#using-the-state-in-navigation">
Using state in navigation
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="tutorial/conversationState.html">
<a href="tutorial/conversationState.html#reading-and-modifiing-user-state">
Reading and writing state
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="tutorial/asyncActions.html">
<a href="tutorial/asyncActions.html">
Asynchronous Actions
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="tutorial/asyncActions.html">
<a href="tutorial/asyncActions.html#blocking-asynchronous-actions">
Blocking Actions
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="tutorial/asyncActions.html">
<a href="tutorial/asyncActions.html#non-blocking-asynchronous-actions">
Non Blocking Actions
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="tutorial/asyncActions.html">
<a href="tutorial/asyncActions.html#loading-attachments-to-buffer">
Loading Attachments
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="tutorial/advancedRouting.html">
<a href="tutorial/advancedRouting.html">
Advanced Routing
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="tutorial/advancedRouting.html">
<a href="tutorial/advancedRouting.html#resolving-actions">
Resolving Actions
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="tutorial/advancedRouting.html">
<a href="tutorial/advancedRouting.html#simple-text-actions">
Text Actions
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="tutorial/advancedRouting.html">
<a href="tutorial/advancedRouting.html#integrating-with-ai-prediction">
Integrating AI
</a>
</li>
<li class="chapter " data-level="1.5.4" data-path="tutorial/advancedRouting.html">
<a href="tutorial/advancedRouting.html#redirecting-flow-with-post-back">
Redirecting with Postback
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.6" data-path="tutorial/nestingRouters.html">
<a href="tutorial/nestingRouters.html">
Nesting - Reusable Blocks
</a>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="tutorial/nestingRouters.html">
<a href="tutorial/nestingRouters.html#basic-concept">
Concept
</a>
</li>
<li class="chapter " data-level="1.6.2" data-path="tutorial/nestingRouters.html">
<a href="tutorial/nestingRouters.html#example">
Example
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" data-path="tutorial/templates.html">
<a href="tutorial/templates.html">
Sending Templates
</a>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="tutorial/templates.html">
<a href="tutorial/templates.html#button-template">
Button Template
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="tutorial/templates.html">
<a href="tutorial/templates.html#generic-template">
Generic Template
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="tutorial/templates.html">
<a href="tutorial/templates.html#receipt-template">
Receipt Template
</a>
</li>
<li class="chapter " data-level="1.7.4" data-path="tutorial/templates.html">
<a href="tutorial/templates.html#working-with-webviews">
Webviews
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="tutorial/testing.html">
<a href="tutorial/testing.html">
Testing
</a>
</li>
<li class="chapter " data-level="1.9" data-path="tutorial/analytics.html">
<a href="tutorial/analytics.html">
Analytics
</a>
</li>
<li class="chapter " data-level="1.10" data-path="tutorial/usingWithWingbot.html">
<a href="tutorial/usingWithWingbot.html">
Using with Wingbot.ai
</a>
<ul class="articles">
<li class="chapter " data-level="1.10.1" data-path="tutorial/usingWithWingbot.html">
<a href="tutorial/usingWithWingbot.html#bot-configuration">
Bot configuration
</a>
</li>
<li class="chapter " data-level="1.10.2" data-path="tutorial/usingWithWingbot.html">
<a href="tutorial/usingWithWingbot.html#express-mongodb">
Express Mongodb
</a>
</li>
<li class="chapter " data-level="1.10.3" data-path="tutorial/usingWithWingbot.html">
<a href="tutorial/usingWithWingbot.html#serverless-aws-lambda">
Serverless AWS Lambda
</a>
</li>
</ul>
</li>
<li class="header">API</li>
<li class="chapter " data-level="2.1" data-path="api/Request.html">
<a href="api/Request.html">
Request
</a>
</li>
<li class="chapter " data-level="2.2" data-path="api/Responder.html">
<a href="api/Responder.html">
Responder
</a>
</li>
<li class="chapter " data-level="2.3" data-path="api/Router.html">
<a href="api/Router.html">
Router
</a>
</li>
<li class="chapter " data-level="2.4" data-path="api/Tester.html">
<a href="api/Tester.html">
Tester
</a>
</li>
<li class="chapter " data-level="2.5" data-path="api/ButtonTemplate.html">
<a href="api/ButtonTemplate.html">
Template Builders
</a>
<ul class="articles">
<li class="chapter " data-level="2.5.1" data-path="api/ButtonTemplate.html">
<a href="api/ButtonTemplate.html#ButtonTemplate">
ButtonTemplate
</a>
</li>
<li class="chapter " data-level="2.5.2" data-path="api/ButtonTemplate.html">
<a href="api/ButtonTemplate.html#GenericTemplate">
GenericTemplate
</a>
</li>
<li class="chapter " data-level="2.5.3" data-path="api/ButtonTemplate.html">
<a href="api/ButtonTemplate.html#ReceiptTemplate">
ReceiptTemplate
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="2.6" data-path="api/Settings.html">
<a href="api/Settings.html">
Bot Settings
</a>
</li>
<li class="chapter " data-level="2.7" data-path="api/express.html">
<a href="api/express.html">
Express/MongoDb tools
</a>
</li>
<li class="chapter " data-level="2.8" data-path="api/bufferloader.html">
<a href="api/bufferloader.html">
Utils
</a>
</li>
<li class="chapter " data-level="2.9" data-path="api/Ai.html">
<a href="api/Ai.html">
Ai
</a>
</li>
<li class="chapter " data-level="2.10" data-path="api/serverlessAWS.html">
<a href="api/serverlessAWS.html">
Serverless
</a>
</li>
<li class="chapter " data-level="2.11" data-path="api/BuildRouter.html">
<a href="api/BuildRouter.html">
Wingbot.ai
</a>
</li>
<li class="chapter " data-level="2.12" data-path="api/callback.html">
<a href="api/callback.html">
Middlewares
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Getting Started</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="chatbot-framework"><a name="chatbot-framework" class="plugin-anchor" href="#chatbot-framework"><i class="fa fa-link" aria-hidden="true"></i></a>Chatbot Framework</h1>
<p><a href="https://circleci.com/gh/davidmenger/botnaut/tree/master" target="_blank"><img src="https://circleci.com/gh/davidmenger/botnaut/tree/master.svg?style=svg" alt="CircleCI"></a></p>
<p>Advanced chatbot framework gives you:</p>
<ul>
<li>Tools for making chatbot on <strong>Facebook Messenger Platform</strong> for <strong>Node.js</strong></li>
<li>The simpliest interface for Messenger platform</li>
<li><strong>Composable Conversation Blocks</strong> system for separating concerns</li>
<li>Familiar Node.js routing interface for <strong>Fast development</strong></li>
<li><strong>Unit tests</strong> friendly bot framework</li>
</ul>
<h2 id="how-to-start"><a name="how-to-start" class="plugin-anchor" href="#how-to-start"><i class="fa fa-link" aria-hidden="true"></i></a>How to start</h2>
<ul>
<li><p><strong>Install the framework</strong></p>
<pre><code class="lang-bash">$ npm i -S botnaut
</code></pre>
</li>
</ul>
<ul>
<li><p><strong>Create your first chatbot</strong></p>
<pre><code class="lang-javascript"><span class="hljs-keyword">const</span> express = <span class="hljs-built_in">require</span>(<span class="hljs-string">'express'</span>);
<span class="hljs-keyword">const</span> { Router } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'botnaut'</span>);
<span class="hljs-keyword">const</span> { createRouter, createProcessor } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'botnaut/express'</span>);
<span class="hljs-keyword">const</span> bot = <span class="hljs-keyword">new</span> Router();
bot.use(<span class="hljs-string">'/hello'</span>, (req, res, postBack) => {
res.text(<span class="hljs-string">'Hello world'</span>);
});
bot.use((req, res, postBack) => {
res.text(<span class="hljs-string">'What you want?'</span>, {
hello: <span class="hljs-string">'Say hello world'</span>
});
});
<span class="hljs-keyword">const</span> processor = createProcessor(bot, {
pageToken: <span class="hljs-string">'pagetokenhere'</span>,
appSecret: <span class="hljs-string">'botappsecret'</span>,
autoTyping: <span class="hljs-literal">true</span>
});
<span class="hljs-keyword">const</span> app = express();
app.use(<span class="hljs-string">'/bot'</span>, createRouter(processor, <span class="hljs-string">'verifyTokenHere'</span>));
mongoose.connect(<span class="hljs-string">'mongodb://localhost/myapp'</span>)
.then(() => app.listen(<span class="hljs-number">3000</span>));
</code></pre>
</li>
<li><p><strong>Deploy and setup Facebook Messenger Application</strong></p>
<ol>
<li>Create Facebook Application for Messenger platform</li>
<li>Create page token and put it in Processor</li>
<li>Create the webhook and use previously created <code>verifyToken</code></li>
<li>Subscribe a page to the FB Application</li>
</ol>
</li>
</ul>
<h2 id="requirements"><a name="requirements" class="plugin-anchor" href="#requirements"><i class="fa fa-link" aria-hidden="true"></i></a>Requirements</h2>
<ul>
<li>requires <code>mongoose</code> >= 4.0</li>
<li>requires <code>nodejs</code> >= 6.0</li>
<li>requires <code>express</code> >= 4.0</li>
<li>requires <code>body-parser</code> >= 1.10</li>
</ul>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="tutorial/buildingConversation.html" class="navigation navigation-next navigation-unique" aria-label="Next page: Building a Conversation">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Getting Started","level":"1.1","depth":1,"next":{"title":"Building a Conversation","level":"1.2","depth":1,"path":"tutorial/buildingConversation.md","ref":"tutorial/buildingConversation.md","articles":[{"title":"Asking a question","level":"1.2.1","depth":2,"anchor":"#asking-a-question","path":"tutorial/buildingConversation.md","ref":"tutorial/buildingConversation.md#asking-a-question","articles":[]},{"title":"Using quick replies","level":"1.2.2","depth":2,"anchor":"#using-quick-replies-for-controlling-conversation","path":"tutorial/buildingConversation.md","ref":"tutorial/buildingConversation.md#using-quick-replies-for-controlling-conversation","articles":[]},{"title":"Postbacks","level":"1.2.3","depth":2,"anchor":"#post-back-is-also-an-action","path":"tutorial/buildingConversation.md","ref":"tutorial/buildingConversation.md#post-back-is-also-an-action","articles":[]}]},"dir":"ltr"},"config":{"plugins":["theme-default","collapsible-menu","anchors"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"collapsible-menu":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"theme-api":{"theme":"dark","languages":[{"lang":"js","name":"JavaScript","default":true}]},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"anchors":{}},"theme":"default","author":"David Menger","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{"twitter":"https://twitter.com/davidmenger"},"title":"Botnaut","gitbook":"*","description":"Facebook Messenger framework for Node.js"},"file":{"path":"README.md","mtime":"2018-05-23T15:20:01.282Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-05-23T15:31:59.833Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-collapsible-menu/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>