Skip to main content

Antrix Documentation

Welcome to the central documentation site for the Antrix project.

This site is meant to serve two groups:

  • team members who need a quick reference for architecture, setup, and release flow
  • new joiners who need a guided path to understand and run the project locally

What lives here​

  • onboarding guides for local development
  • high-level architecture and service boundaries
  • service summaries for each major Antrix repository
  • deployment and release notes
  • troubleshooting notes and known gotchas
  • documentation ownership rules

Current project shape​

The working folder currently contains multiple sibling projects rather than one monorepo:

  • intt-mobile
  • intt-portal
  • mvp1-authentication-service
  • mvp1-setting-service
  • mvp2-data-service
  • mvp3-caution-report-queue-service
  • mvp3-changedp-queue-service
  • mvp3-ctt-queue-service
  • mvp3-gsb-queue-service
  • mvp3-gsb-service
  • mvp3-kci-queue-service
  • mvp3-ngoss-service
  • mvp3-nocgrid-service
  • mvp3-nocpro-service
  • mvp3-ticket-service
  • mvp3-tmf-service
  • mvp6-tass-queue-service
  • mvp6-vital-queue-service
  • mvp6-vital-service

Because of that, this documentation site lives in its own folder, intt-docs, so it can describe the full platform instead of only one app.

Read this first​

If you are new to the project, use this order:

  1. Onboarding Overview
  2. Pick your track:
  3. System Overview
  4. Service Map

Scope note​

This documentation set is the shared entry point. Very detailed implementation notes may still live inside each service repository, but this site should always answer:

  • what the service is for
  • how to run it
  • how it fits into the bigger Antrix platform
  • which repos are background queue workers versus primary APIs
  • which client apps exist across web and mobile