Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cliffano/convo-generator

Convo agent and middleware generator using Yeoman
https://github.com/cliffano/convo-generator

code-generator convo

Last synced: 15 days ago
JSON representation

Convo agent and middleware generator using Yeoman

Host: GitHub
URL: https://github.com/cliffano/convo-generator
Owner: cliffano
License: mit
Created: 2018-08-23T00:01:01.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2021-08-14T12:19:20.000Z (over 3 years ago)
Last Synced: 2024-12-03T20:44:07.626Z (about 1 month ago)
Topics: code-generator, convo
Language: HTML
Homepage:
Size: 83 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Build Status](https://img.shields.io/travis/cliffano/convo-generator.svg)](http://travis-ci.org/cliffano/convo-generator)

[![Dependencies Status](https://img.shields.io/david/cliffano/convo-generator.svg)](http://david-dm.org/cliffano/convo-generator)

[![Coverage Status](https://img.shields.io/coveralls/cliffano/convo-generator.svg)](https://coveralls.io/r/cliffano/convo-generator?branch=master)

[![Published Version](https://img.shields.io/npm/v/generator-convo.svg)](http://www.npmjs.com/package/generator-convo)




[![npm Badge](https://nodei.co/npm/convo-generator.png)](http://npmjs.org/package/convo-generator)

Convo Generator

---------------

Convo Generator is a [Convo](http://github.com/cliffano/convo) agent and middleware generator using [Yeoman](http://yeoman.io/).

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

* A Convo agent in the form of [Dialogflow export zip](https://dialogflow.com/docs/agents/export-import-restore) which can then be imported or restored into your Dialogflow project

* A Convo middleware in the form of [Serverless app with CloudFunctions](https://github.com/serverless/serverless-google-cloudfunctions) which can then be deployed to your GCP project.

Please have a look at [Convo Thomas](http://github.com/cliffano/convo-thomas), [Convo Hacker News](http://github.com/cliffano/convo-hacker-news), and [Convo Jenkins](http://github.com/cliffano/convo-jenkins) as examples of how Convo Generator can be used.

Installation

------------

Install [Yeoman](http://yeoman.io/), [Serverless](https://serverless.com/), [dialogflow-cli](https://www.npmjs.com/package/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:

* [Environment configuration](https://github.com/cliffano/convo/blob/master/docs/conf-environment.md)

* [Convo specification](https://github.com/cliffano/convo/blob/master/docs/conf-convo-specification.md)

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

| Middleware Type | Configuration File |

|-----------------|--------------------|

| OpenAPI-CloudFunctions | [OpenAPI specification](https://github.com/cliffano/convo/blob/master/docs/conf-openapi-specification.md) |

Usage

-----

### DialogFlow agent

Generate DialogFlow agent:

    yo convo dialogflow-agent  

Deploy the generated agent:

    dialogflow-cli import --credentials  

Alternatively, you can zip up the generated agent, and then [import or restore the zip file](https://dialogflow.com/docs/agents/export-import-restore) to Dialogflow.

### Freestyle-CloudFunctions middleware:

Generate Freestyle-CloudFunctions middleware:

    yo convo freestyle-cloudfunctions-middleware  

Deploy the generated middleware:

    serverless deploy

    

### OpenAPI-CloudFunctions middleware:

Generate OpenAPI-CloudFunctions middleware:

    yo convo openapi-cloudfunctions-middleware   

Deploy the generated middleware:

    serverless deploy

Colophon

--------

Related Projects:

* [Convo](http://github.com/cliffano/convo) - Specification-based voice and text conversation library

* [convo-node](http://github.com/cliffano/convo-node) - node.js utility module for Convo library

* [Convo Thomas](http://github.com/cliffano/convo-thomas) - Convo agent for Thomas the Tank Engine Facts

* [Convo Hacker News](http://github.com/cliffano/convo-hacker-news) - Convo agent and middleware for Hacker News

* [Convo Jenkins](http://github.com/cliffano/convo-jenkins) - Convo agent and middleware for Jenkins