Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 750 Bytes

File metadata and controls

19 lines (15 loc) · 750 Bytes

Docs

This directory contains a set of documents describing all of the important details of JSCAS. Such documentation covers the configuration of the server to how to implement plugins.

Tip: use npm run docs from the project root directory to browse the documentation in a web browser.

TOC

  • API: details about the included API for plugin authors.
  • Configuration: descriptions of the available configuration parameters.
  • Hooks: details on lifecycle hooks provided by JSCAS.
  • Plugins: details the plugins API and how to implement specific plugin types.
  • Tickets: details what "tickets" are and how JSCAS expects them to be shaped.