ECTS Documentation

This documentation set covers both codebases in this workspace:

  • ects-backend (Java service: APIs, protocol processing, persistence, auth, reporting)
  • web-portal (React/Vite portal: role-based UI, operational workflows, route modules)

The content is split into technical docs for engineers and detailed user guides for portal operators.

Client Download

For client sharing, use the public ECTS Client Documentation Pack library. It includes the full external pack plus separate User Guide, Operations and Deployment Guide, and Technical Overview PDFs.

What Is Included

  • Backend architecture, module inventory, request/data flow, API contract, and extension guidance
  • Frontend architecture, routing model, state/data access patterns, and role gates
  • API documentation and catalog mapped from resource classes and OpenAPI/governance artifacts
  • Security and RBAC behavior across backend and portal
  • Step-by-step user workflows with screenshots
  • Operations runbooks for incidents, monitoring/SLOs, and DR
  • Reference catalogs for configuration, data model, and ownership/escalation
  • Release/quality guidance and ADR-based architecture governance

Documentation Map

  • Getting Started: local run instructions for backend, frontend, and docs site
  • Architecture: system overview, runtime topology, deployment architecture, component/sequence rendered diagram catalog
  • Backend: developer guide, technical deep dive, API documentation, API catalog, RBAC details
  • Frontend Portal: developer guide, technical deep dive, route/permission matrix
  • User Guides: practical operations walkthroughs with screenshots
  • Operations: incident runbook, monitoring/SLO model, backup/restore/DR
  • Reference: environment/config matrix, conceptual data model, ownership/support matrix
  • Security: hardening and access review framework
  • Release and Quality: release pipeline, rollback policy, testing strategy
  • Governance: ADR index and documentation governance standards

Screenshot Baseline

Portal screenshots in this documentation are in docs/assets/screenshots/ and include live-captured super-admin session pages from https://ects.keshiholdings.com (March 2, 2026).

ECTS Login Screen