Skip to content

IQV API Middleware

Documentation home page for the IQV API Middleware application.

What's in this documentation?

  • Overview — what IQV API Middleware is, its general purpose, core functions, target users, system components, and general workflow.
  • Pages — for every real screen in the app: purpose, fields, user actions, data used, access/visibility, components, API communication, and state management.
  • API Documentation — every real backend endpoint, the authentication method, and environment variables.
  • Development — local development environment setup and common commands.
  • CI Quality Report — information about the automated quality report produced by the GitHub Actions CI workflow.

Project Structure

This repository's CI workflow is defined in .github/workflows/ci.yml at the repository root; the frontend (dashboard) code lives under the dashboard/ folder, and the backend/API code lives under the backend/ folder. See dashboard/README.md and the Development page for detailed setup and commands.

For the full breakdown of the app's real pages/routes, services, state, and role structure, see the Overview and Pages sections — this page is only an entry point.