Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.25 KB

README.md

File metadata and controls

40 lines (26 loc) · 2.25 KB

Overview

Rivr is a lightweight open-source dialogue engine enabling Java developers to easily create enterprise-grade VoiceXML applications.

Read our Getting Started to learn more.

Command Line

To build from the command line, use the gradlew script: ./gradlew build on *NIX and gradlew.bat build on windows. To show a list of the usable tasks, run gradlew tasks.

Note: remember that Gradle permits camel-case shortcuts for the task name, as such teCl resolves to testClasses.

Configuring the Gradle wrapper

The gradle wrapper can be configured via the gradle-wrapper.properties file, under the gradle/wrapper folder. The most important property is the distributionUrl, which determines which version of Gradle is downloaded. The pattern for the url is: http://services.gradle.org/distributions/gradle-[versionNumber]-[versionStyle].zip. The versionStyle can be either bin or all; bin only contains the runtime, where all also contains the documentation and source. By default, we are using bin.

Eclipse integration

Install the Gradle IDE plugin from Spring's update site. To load the projects inside Eclipse, choose File -> Import -> Gradle -> Gradle Project, select the root directory of the project, click Build Model and finish.

You can also configure which version of Gradle the IDE plugin uses: go to Window -> Preferences -> Gradle and change the URI of Gradle distribution. This is the same URL pattern as the Gradle wrapper.

Dependency declaration

To reference the published artifact, you declare a dependency on "com.nuecho:rivr-voicexml:0.9.2". For the web interface (aka voicexml dialogue runner), here's the recipe to include it in a dependent webapp:

apply plugin: 'war' // Must be a webapp project
configurations { dialogueRunner } // The name of the configuration can be anything
dependencies {
    dialogueRunner 'com.nuecho:dialogue-runner:0.9.2@war'
}
repositories { mavenCentral() }
war{
    def dialogueRunner = { zipTree(configurations.dialogueRunner.singleFile) } // This enables lazy resolving
    from(dialogueRunner)
}

This is the Gradle recipe for war overlaying, simplified for only one file.