webbybot

KO | EN

gitlite — search

#java #javascript #php #rust #docker #python #hacktoberfest #c-plus-plus #css #sqlite #es6 #react

★ 68 Open GitHub ↗

chatterbot written in es6 (es2015), fork from hubot

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Webbybot

**THIS PROJECT IS NOT MAINTAINED, please consider [Hubot](https://github.com/hubotio/hubot) or my client-side attempt [Saihubot](https://github.com/gasolin/saihubot) **

[![Build Status](https://travis-ci.org/gasolin/webby.png)](https://travis-ci.org/gasolin/webbybot) [![codecov.io](https://codecov.io/github/gasolin/webbybot/coverage.svg?branch=master)](https://codecov.io/github/gasolin/webbybot?branch=master) [![Dependency Status](https://david-dm.org/gasolin/webbybot.svg)](https://david-dm.org/gasolin/webbybot) [![npm](https://img.shields.io/npm/v/webbybot.svg)](https://www.npmjs.com/package/webbybot)
[![Join the chat at https://gitter.im/gasolin/webbybot](https://badges.gitter.im/gasolin/webbybot.svg)](https://gitter.im/gasolin/webbybot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[Webbybot](https://github.com/gasolin/webbybot/) is the next generation framework to build message/chat bots, written in ES6 and plain javascript.
Fully compatible with [Hubot](https://github.com/github/hubot)'s middleware and plugins.

The Differences:

* Port hubot from CoffeeScript to ES6 (plain JS) with babel.
* Auto test coverage report with Codecov.
* Auto linting with eslint.
* Support .env file to setup system parameters
* robot.router upgraded to Express 4.x

The Same:

* Still support hubot plugins written in coffeescript.
* Can reuse hubot adapters*
* Auto continue integration with Travis CI.
* [How it works](https://github.com/github/hubot/blob/master/docs/implementation.md)(for now)
* Support write plugin with plain Javascript

## How to try Webbybot

You can start from [webby-template](https://github.com/gasolin/webby-template) , a template for make a working webby bot

```shell
$ git clone https://github.com/gasolin/webby-template.git demo
$ cd demo
$ npm install
$ ./bin/webby
```

You can find and install extra skills from [npm](https://www.npmjs.com/search?q=hubot)

Enable a skill in `external-scripts.json`.

Add the environment variables in [.env](https://www.npmjs.com/package/dotenv) file.

## How to replace Hubot to Webbybot

Refer to [Getting Started With Hubot](https://hubot.github.com/docs/),
Install hubot generator first

```shell
npm install -g yo generator-hubot
```

Then generate your robot with
```shell
yo hubot
```

1. Enter the folder, edit `bin/hubot` and replace `hubot` to `webby`.

2. install webbybot package

```shell
npm install --save webbybot
```

3. modify adapter's dependency

Let's take telegram adapter for example. Edit `node_modules/hubot-telegram/src/telegram.coffee` and replace first line `require 'hubot'` to `require 'webbybot'`.

start your bot as normal

```shell
./bin/hubot
```

Tested with `hubot-telegram` and `hubot-messenger`.

## Development

```shell
$ npm install -g mocha
```

### Build

run command

```shell
$ npm run build
```

### Add plugins

```shell
$ npm install hubot-calculator hubot-diagnostics
```

Add external-scripts.json file which contain:

```javascript
[
  "hubot-diagnostics",
  "hubot-calculator"
]
```

### Run

run command

```shell
$ node ./bin/webby
webby > ping
webby > PONG
webby > echo hello
webby > hello
webby > webby calc 1 + 1
webby > 2
```

### Test

```shell
$ npm test
```

### Lint
```shell
$ npm run lint
```

### Write your own plugin

You can clone [webby-plugin](https://github.com/gasolin/webby-plugin) template to get start.

[webby-template](https://github.com/gasolin/webby-template) already bundled with webby-plugin. You can check how it work for reference.

## License

[MIT license](https://en.wikipedia.org/wiki/MIT_License)

webbybot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README