- AskSusi Messengers
AskSusi is a messenger bot that answers your question by using big data
from loklak and a number of API services. In this repository we keep
AskSusi chatbots for social media platforms. We have integrated AskSusi
on Facebook Messenger, Slack and Telegram. All of the messenger bots
work from one central
index.js file, and run from one URL (with
different paths). The type of questions Susi can currently answer can be
found in the loklak documentation
Facebook Bot for Susi¶
A live version of Susi’s Messenger bot can be found at facebook.com/asksusisu/. Personal Message the page to speak to Susi.
Slack Bot for Susi¶
You can directly talk to Susi using the
Add to Susi button above.
Click on that button, and add Susi to your team. Talk to it by typing
@susi followed by your message.
How do I install AskSusi on Slack¶
For making your own Slack Bot for Susi, please check out the
Installation document. Or you can
directly deploy AskSusi onto your team by clicking on the
Add to Slack button below.
As of now, all the bots have been developed in
Express for smooth builds and CI, so if you wish to add more bots,
Roadmap and Contributions¶
We would love to see AskSusi on more platforms. Please help us to develop AskSusi bots for other platforms.
For contributing, please follow the follow the steps below:
- Please append your code in the
index.jsfile (without altering the other bots). Add a comment line specifying your platform, like:
// <platform> BOT FOR SUSIand then write your code below it.
package.jsonwith your external
npmpackages (if you are using them), i.e when you wish to use an external dependancy for your bot, just add the
saveflag as well:
npm install --save <package>
Add the installation / deployment instructions for your bot in the
installation_docsfolder, in a
.mdfile. Keep the filename as
INSTALLATION_<botplatform>.md. You should write how to setup such a bot on your platform, and how to make it consume the Susi API. To get a better idea, you can check the instructions of the other docs here.
Add a screenshot of your working bot, along with usage (i.e message format) in the
README.md. Also write that the installation instructions of your bot can be found at
<link to your installation documentation>.
Finally, send a single, squashed PR containing all these changes. Please send your PRs to the
The default branch is
development, so make sure you contribute only
on this branch.