Skip to content

README.md

Latest commit

 

History

History
27 lines (19 loc) · 1.45 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.45 KB

FacetJsClient

2021-Feb-09
CMSB

A Javascript client for the Virtuoso Faceted Browsing Service.

FacetJsClient is a Javascript interface to Virtuoso's /fct/service. It aims to be a client library with no UI dependencies with a view to it being usable by any UI framework. FacetReactClient provides a React-based UI to the Virtuoso Faceted Browsing Service, using FacetJsClient for its underpinnings.

See also:

Setup & Testing

A Karma test setup is included for testing of the library from within a browser, Headless Chrome in this case.

  • Install the required npm modules using npm install.
  • To run the tests:
    • Edit test/test.conf.js so that fct_test_endpoint points to the URL of your test Facet service endpoint. (Default: http://localhost:8896/fct/service)
    • npm test
  • To run the tests in debug mode to allow debugging using Chrome Dev Tools debugger
    • npm run debug
    • Point your browser to http://localhost:9876, set a breakpoint then refresh the page
  • To generate the JSDoc documentation
    • npm run doc