The best conversational AI framework
Branch: master
Clone or download
Latest commit a810a55 Feb 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deploy-scripts cp2server Feb 3, 2019
docs new docs, new removeTarget(s)Action Feb 5, 2019
editor mid-way setInterval Feb 8, 2019
server twilio bug fix Feb 13, 2019
README.md Update README.md Feb 17, 2019
_config.yml Set theme jekyll-theme-time-machine Jan 20, 2019
lxQOk1@426x240.gif add videos Jan 22, 2019

README.md

Servo.ai

Servo Bot Automation Framework is the leading framework for building bots and automation flows. It allows developers to use visual architecture, open code and reusable AI.

Go to dev.servolabs.org:8081 for a playground

Or click to watch a short intro video:
Servo]

Installation

  1. install nodejs (v8 or v9) and npm (v5.5 and above)
  2. clone and install:
    • sudo npm install -g gulp bower
    • git clone https://github.com/servo-ai/servo-platform.git
    • cd servo-platform/server
    • optional: Windows: npm install --global --production windows-build-tools / *Nix: sudo apt-get install build-essential libssl-dev
    • npm install
    • cd ../editor
    • npm install
    • bower install

If you get errors during npm install, then: * on windows: npm install --global --production windows-build-tools * linux: sudo apt-get install build-essential libssl-dev

Run Servo

From server or editor folder:
cd server && npm start

On the browser open localhost:8000

Tutorials

To get started, see the wiki: https://github.com/servo-ai/servo-platform/wiki

For reference documentation, see https://servo-ai.github.io/servo-platform/


Build documentation

  • cd server
  • jsdoc ./ -r -c ./jsdoc-config.json -d ../docs -t ./ink-docstrap/template -R ./README.md
  • npm run cpdoc

Optional/advanced installations:

Terminals

Servo uses two apps, one for the server and one for the editor. npm start will run them both on the same terminal. you can, however, run them in two separate terminals:

  • cd server && node app.js
  • cd editor && gulp serve

Database:

couchbase

  • install couchbase
  • restore from release-proc/couchbase-buckets
  • change db entry at src/server/config.json to 'couchdb'

mongodb

  • install mongodb
  • change db entry at src/server/config.json to 'mongo'

Certificates:

  1. get a new domain

  2. Install a certificate

  • all certificates should be put under a server/certificates/ folder, with following names: **cert.pem **chain.pem **privkey.pem

  • change entries at server/config.json: "serverBaseDomain": "<domain>", "openSSL": true,

E2E/Unit tests:

npm test

#License and copyright

  • Server is licensed under AGPL

  • Client is licensed under MIT license

    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Copyright (c) 2016-2019 Servo Labs Inc Some of the source files have parts Copyright by Renato de Pontes Pereira