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.
What Is Included¶
- Backend architecture, module inventory, request/data flow, and extension guidance
- Frontend architecture, routing model, state/data access patterns, and role gates
- API catalog mapped from resource classes and OpenAPI/governance artifacts
- Security and RBAC behavior across backend and portal
- Step-by-step user workflows with screenshots
Documentation Map¶
- Getting Started: local run instructions for backend, frontend, and docs site
- Architecture: system-level overview and component interaction
- Backend: deep technical guide, API catalog, RBAC details
- Frontend Portal: deep technical guide, route/permission matrix
- User Guides: practical operations walkthroughs with screenshots
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).
