coveo-interface-editor

Coveo JS Search

The JS Search is our awesome search interface written in TypeScript which communicate with the index via the Search API.

Getting started

install node / npm version 4        # https://nodejs.org/en/
cd path/to/cloned/repo
npm install -g gulp                  # Gulp is the build tool, -g to install globally (so you can call gulp directly in the cmd line)
npm install                         # Install all the local dependencies for the project
gulp                                # Compile the project (you may need to use ./node_modules/.bin/gulp).

See Gulpfile.js for more options.

Viewing the Interface Editor

From the jssearchlib\demo folder: node server.js # Runs the search interface in a local server on port 3000

With a browser, go to http://localhost:3000 to view the search interface and the interface editor

Troubleshooting

You receive no such package available -like NPM errors.

This project uses NPM packages from public and private repositories. Make sure those 2 repositories are accessed when resolving dependencies:

npm set registry https://registry.npmjs.org/
echo @coveo:registry=http://npm.corp.coveo.com >> ~/.npmrc