Installation

Learn how to install Jovo, the open source framework for voice and chat apps.

Introduction

Jovo is an open-source framework based on TypeScript which can be used with both TypeScript and JavaScript. If you run into any problems while installing it, please let us know in the Jovo forum or create an issue on GitHub.

Before getting started, make sure you have the following installed on your computer or development environment:

  • Node.js version 12.x or later
  • npm (node package manager)

There are two ways how you can install Jovo:

If you're looking to migrate to Jovo v4 from a v3 project, take a look at our migration guide.

Install the CLI

You can install the new Jovo CLI like this:

$ npm install -g @jovotech/cli

After successful installation, you should be able to see the Jovo CLI menu by typing the following into your command line:

$ jovo

Create a new Project

After installing the Jovo CLI, you can install the template (TypeScript or JavaScript) using the new command:

$ jovo new <directory>

This will download the template into a new <directory> folder and install all necessary dependencies.

Run the Local Development Server

Change your working directory into your newly created project directory and run your app:

# Change working directory to your previously specified directory
$ cd <directory>

# Run the local development server
$ jovo run

You can now open the Jovo Debugger with the . key.

Clone a Sample App

You can find a sample project for a Jovo app on GitHub:

You can clone it like this:

# TypeScript version
$ git clone https://github.com/jovotech/jovo-v4-template.git

# JavaScript version
$ git clone https://github.com/jovotech/jovo-v4-template-js.git

Then go into the directory and install the dependencies:

$ npm install