Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including generator-convo with all npm packages installed. Try it out:

generator-convo lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("generator-convo/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

generator-convo v0.0.5

Convo agents and middlewares generator using Yeoman

Avatar

Build Status Dependencies Status Coverage Status Published Version
npm Badge

Convo Generator

Convo Generator is a Convo agent and middleware generator using Yeoman.

This generator reads the environment configuration, Convo specification, and OpenAPI specification, which would then be used to generate:

Please have a look at Convo Thomas, Convo Hacker News, and Convo Jenkins as examples of how Convo Generator can be used.

Installation

Install Yeoman, Serverless, dialogflow-cli:

npm install -g yo serverless dialogflow-cli

Install Convo Generator itself:

npm install -g convo-generator

Configuration

Create the following mandatory configuration files:

And depending on the middleware type specified in your Convo specification, you need to provide these additional configuration files:

Middleware TypeConfiguration File
OpenAPI-CloudFunctionsOpenAPI specification

Usage

DialogFlow agent

Generate DialogFlow agent:

yo convo dialogflow-agent <path/to/env-config.yaml> <path/to/convo-spec.yaml>

Deploy the generated agent:

dialogflow-cli import --credentials <path/to/project-credentials.json> <path/to/generated-agent-dir/>

Alternatively, you can zip up the generated agent, and then import or restore the zip file to Dialogflow.

Freestyle-CloudFunctions middleware:

Generate Freestyle-CloudFunctions middleware:

yo convo freestyle-cloudfunctions-middleware <path/to/env-config.yaml> <path/to/convo-spec.yaml>

Deploy the generated middleware:

serverless deploy

OpenAPI-CloudFunctions middleware:

Generate OpenAPI-CloudFunctions middleware:

yo convo openapi-cloudfunctions-middleware <path/to/env-config.yaml> <path/to/convo-spec.yaml> <path/to/openapi-spec.yaml>

Deploy the generated middleware:

serverless deploy

Colophon

Related Projects:

  • Convo - Specification-based voice and text conversation library
  • convo-node - node.js utility module for Convo library
  • Convo Thomas - Convo agent for Thomas the Tank Engine Facts
  • Convo Hacker News - Convo agent and middleware for Hacker News
  • Convo Jenkins - Convo agent and middleware for Jenkins

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free