reyadrahman / jovo-framework-nodejs

🔈 Build cross-platform voice applications for Amazon Alexa and Google Home

The development framework for cross-platform voice apps

Documentation - CLI - Sample App - Contributing - Twitter

Table of Contents

• Getting Started
  • Jovo CLI
  • Jovo Framework
  • Jovo Sample App
• Tutorials
• Development Roadmap

Getting Started

There are three ways to get started with the Jovo Framework. You can either install our command line tools (recommended), save the jovo-framework npm package, or clone our sample voice app.

Technical Requirements: Node.js version 4 or later & NPM (node package manager). Here are some tutorials to install Node.js and NPM: Mac, Windows.

Jovo CLI

The Jovo Command Line Tools offer an easy way to create new voice apps from templates. Install them with:

$ npm install -g jovo-cli

You can create a Jovo project into a new directory with the following command:

$ jovo new <directory>

This will clone the Jovo Sample App and install all the necessary dependencies so you can get started right away.

Jovo Framework

If you want to use the Jovo Framework as a dependency in an already existing project, you can also use npm to save it to your package.json:

$ npm install --save jovo-framework

Jovo Sample App

Right now, there is one sample app available, which you can find here.

You can clone it like this:

$ git clone https://github.com/jovotech/jovo-sample-voice-app-nodejs.git

Afterwards, go to the app directory and do

$ npm install

Tutorials

Find a quickstart guide and comprehensive tutorials here:

• Build a cross-platform voice app in 5 simple steps
• Build an Alexa Skill with Jovo
• Build a Google Action with Jovo

Development Roadmap

We still consider this a beta-version of the Jovo framework: We give it our all to make it as complete as possible (and it supports most of the Alexa and Google Assistant functions), but there are certain features that are currently in development.

What we're currently working on:

• Adding more DB integrations
• Extending the User class

We need your help

Jovo is a free, open source framework for voice developers. We're improving it every day and appreciate any feedback. How to support us? Just go ahead and build something cool with the framework and let us know at [email protected]. Thanks!