gasolin / saihubot Goto Github PK

View Code? Open in Web Editor NEW

17.0 2.0 2.0 10.33 MB

:speech_balloon: client side chatbot that works in the browser and command line

Home Page: https://gasolin.github.io/saihubot/

License: MIT License

JavaScript 2.08% HTML 0.26% CSS 97.66%

bot-framework chatbot javascript-bot hubot browser-bot chat-bot

saihubot's Introduction

Saihubot

🤖 Frontend Framework to build 💬 message/chat bots ops in the 🌐 Browser or Command Line, no server required.

You can add new skills to bot via skills and extend its ability via addons. All with plain javascript. 👏

Saihubot's API is inspired by hubot's API, so a developer who has learned hubot-plugins could learn saihu-skills very quickly. ⚡

Check Online Demo

Or run the command bot without install

npx saihu npm saihu

Features

Chatbot works in multiple platforms, without server setup.
Structure was inspired by hubot
- Regex based message matching
- Could write adapter to fully cooperate with your web UI
- Could swap brain to support different backends
- Provide skills(pluginn) architecture that able to expand functions
- Can extend bot functionality by import addons
Tiny size, easy to learn (the init version has just 80 lines that bundle with three skills)
Plugin callbacks are extremely flexible; You can control in-page elements, execute the local command, fetch remote data, trigger remote actions...

Modules

Module	Version	Description	Doc
saihubot		core module	Doc
saihu		Sample Command line bot	Doc
Web samples	Online Demos

Adapters	Description	Doc
saihubot-html-adapter	HTML	Doc
saihubot-react-redux-adapter	React + Redux	Doc
saihubot-cli-adapter	Command Line	Doc

Skills	Description	Doc
saihubot-skill-search	Search engines	Doc
saihubot-skill-diagnostics	ping, echo, current time	Doc
saihubot-cli-skill-qrcode	generate qrcode	Doc

How to use

Try Saihubot samples online

If you just want to try how the saihubot looks like, Check Online Demo

Try Saihubot locally

Clone the project with command

git clone https://github.com/gasolin/saihubot.git

Then run

npm build
npm start

npx http-server .

now you have a working bot in the browser!

Try Saihubot on Github

Fork the project, edit index.html with Github editor, save it and see the result on https://[yourname].github.io/saihubot

Saihubot also provide Search skills, you can include it via skillsFile: ['skills/saihubot-search.js']

Check the Search Demo.

🔎 Google Search skill:

me: g saihubot
bot: Search saihubot via Google
me: google saihubot
bot: Search saihubot via Google
me: search saihubot
bot: Search saihubot via Google

Want to learn more?

Check the docs section.

What Saihu means?

Saihu(師傅) means master in Taiwanese, which people used to call the artisans. Saihubot's origin goal is to provide a code sample that makes learning hubot and its ES6 variant Webbybot easier; then I found Saihu is a great way to embed bot into anywhere browser can live with.

License

Saihubot use MIT License

ChangeLog

Check ChangeLog

saihubot's People

Contributors

Stargazers

Watchers

Forkers

jimmyliao eunice730711

saihubot's Issues

implement saihubot-prompt addon

API:

huohubot.prompt(title, callback, [fail_message])

wait input for 30 seconds

SAIHUBOT_ETH_ADDRS=addr1, addr2

run getConfig('LANG')

should return as 'en' (string)

run getConfig('ETH_ADDRS')

should return as [addr1, addr2] (array)

https://github.com/gasolin/saihubot in gh-pages branch
- index.html
- docs
- samples
- src
  - adapters
  - addons
  - core
  - skills

https://github.com/gasolin/saihubot-cli in main branch
- src
  - adapters
  - addons
  - cli.js

suggest structure: (monorepo manage by lerna)

keep commit in gh-pages branch so current html version will keep working

Name modules as saihubot-[adapter]-[addon|skill]-[name]

https://github.com/gasolin/saihubot in gh-pages branch
- index.html
- cli/ // previous https://github.com/gasolin/saihubot-cli 
- docs
- samples
- packages
  - core
  -  html-adapter
  - html-addon-search
  ...
  - html-skill-search
  ...
  - cli-adaper
  - cli-addon-search
  ...
  - cli-skill-search
  ...

include keyword saihubot, saihubot-adapter, saihubot-skill, saihubot-addon in package.json

http(URL)
  .query({})
  .header('User-Agent', 'Mozilla/5.0')
  .get(err, res, body) {...}

validate
add

Then we can implement more functions in followup bugs

remove by id
run by id
gen help

i18n: {
  'en': {
    ticker: 'High {{high}} / Low {{low}}'
  },
  'zh_TW': {
     ticker: '高 {{high}} / 低 {{low}}'
  }
}

call robot.addon.t('ticker') to render string

call robot.addon.i18n.language to get current lang

ref https://www.i18next.com/translation-function/interpolation

requirement:{
  brain: {
    props: ['read', 'config'],
  }
}

when user type something, the bot will parse it and treat as its selection

[addon idea] google app script backend to extend bot's capability

ADV:

as the proxy to APIs that not accept CORS
JS like google app script are used
hide sensitive token to frontend
able to set a scheduler to run craw script periotically

[addon idea] scheduler

cron like scheduler to notify by time/date