Skip to content

ValFraNath/apothiquiz-api-docs

Repository files navigation

Apothiquiz API Documentation

API Documentation for the Apothiquiz server. Generated with apidoc.

Installation

  1. Clone this repository next to the server code repository
  2. Run githooks/setup-hooks.sh
  3. Run npm install to install apidoc

Updating the docs

  1. Run npm run build to build the new documentation
  2. Preview your changes
  3. Commit (will rebuild the documentation)
  4. Push
  5. Changes are deployed to Github Pages!