Coveo-Platform-Client

A simple client to pull data from your code and Coveo organization and start filling the IOW for you.

Description

A simple client to pull data from your code and Coveo organization and start filling the IOW for you.

Installation

Alternatively, if you are using NPM 5.2+ you can use npx instead of installing globally:

npx iow-data-filler (the recommended way)

Alternatively, through cloning with git or by using npm :

npm install -g iow-data-filler

And the IOW data filler client will be installed globally to your system path.

Usage the command line tool

Interactive tool

Commands

For CLI options, use the -h (or --help) argument:

To get help regarding a specific command, run platformclient <command> --help.

platformclient <command> [options] <origin> <destination> <apiKey>

Description

1. <command>: Available test and test commands
2. [options]: Command options
3. <organization>: The origin organization
4. <apiKey>: An API key assigned to you by the Coveo Cloud Platform. You can view that api key if you connect to the Coveo Cloud Platform and open the developer console

Examples

Development

Important Gulp Tasks

• gulp default: Builds the entire project
• gulp dev: Starts a nodemon dev server as well as the tests.
• gulp test: Builds and runs the unit tests and saves the coverage.

Dev server

gulp dev

This will start nodemon dev server instance. Any time you hit Save in a source file or in a test file, the dev server will reload and re-run your tests.

Tests

NOT DONE YET Tests are written using MochaJS. You can use gulp test to run the tests.

Code coverage will be reported in ./coverage

Available Coveo documentation

The code for the projects uses APIs, SDKs, and code from the Coveo Platform. You can use the following resources for more information and get started:

• Cloud Platform API general documentation: https://developers.coveo.com/display/public/CloudPlatform/Coveo+Cloud+V2+Home
• Cloud Platform Swagger: https://platform.cloud.coveo.com/docs?api=Platform (use the drop-down list to navigate the API categories, top-right of the page).
• PushAPI documentation: https://developers.coveo.com/display/public/CloudPlatform/Push+API+Usage+Overview
• Usage Analytics Swagger: https://usageanalytics.coveo.com/docs/
• Coveo Search UI Framework: https://github.com/coveo/search-ui

It's also built on nodejs/typescript.