vega/voyager-server

Name: voyager-server

Owner: Vega

Description: null

Created: 2017-05-24 15:26:52.0

Updated: 2017-12-22 07:48:17.0

Pushed: 2017-12-04 08:00:34.0

Homepage: null

Size: 197

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

voyager-server

API for running core features of voyager on a backend server.

This is an express app that can be used to offload Voyager's process-heavy tasks to a backend service.

NOTE: This repo provides only a server-side API for a small set of features from voyager. For the main client-side application, please see the voyager repo.

Features

voyager-server currently provides two endpoints:

/recommend : POST request. Executes fetchCompassQLRecommend from voyager and returns results in serialized JSON.

/build : POST request. Executes fetchCompassQLBuildSchema from voyager and returns results in serialized JSON.

Development

We are using yarn for dependency management.

Should pull down the needed npm packages

 start

Will start the server in dev mode.

Build

 build

Will create a compiled version of the code at:

d/server

This compiled code can then be run normally with node:

 build/server