Setup

Requirements

  • Linux or OSX (Windows is currently not supported, but help is welcome)
  • Chrome (some issues with other browsers)
  • A recent version of Docker
  • A recent version of Node.js

See the Installing requirements section.

Installation

Run the following command in your terminal:

npm install -g botfront

When installation is complete Botfront will propose you to create your first project.

At any time you can access the Botfront menu to create or run a project by running botfront in your shell.

Congrats, you can skip the rest of this page and go directly to the next tutorial.

Installing requirements

This section is only required if you don't have Node.JS or Docker installed on your system. If you succesfully completed the steps above, you can safely skip this section

Install Docker

Just download and execute Docker for MacOS or Windows

Install Node.JS

Windows

Download and install Node.js

If you have a missing write access to usr/local/lib/node_modules error when installing Botfront, prepend the command with sudo) and use your usual password when prompted:

sudo npm install -g botfront

Mac / Linux

Install Node.js via nvm to avoid permission errors.

  1. Install NVM
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

then do nvm -V. If you have a command not found error, do touch ~/.bash_profile and repeat the installation (curl ...)

  1. Install Node.js
nvm install --lts