How oqtopus-team/qdash works
Main components
• Frontend (UI): Represented by the “ui” directory (built with Next.js/React). This layer handles user interaction, visualization (charts, tables) and communicates with the backend via API calls.
• Backend API: Under “src/qdash/api” which contains routers, API business logic, authentication, and integration with other internal modules such as calibration and file handling.
• Database & Data Models: Shown by directories “src/qdash/dbmodel”, “src/qdash/datamodel” and “src/qdash/db/init”. These handle persistence for users, calibration data, execution history, and more.
• Workflow Engine: Contained in “src/qdash/workflow” and its subcomponents. This module orchestrates calibration workflows, task scheduling, plugin integrations (e.g. bluefors), and chain-of-task executions.
• CLI Tools: Under “src/qdash/cli”. They likely facilitate command-line access to execute workflows or administrative tasks.
• External Integrations: Within the backend “src/qdash/api/lib” (for authentication and Slack notifications) and in workflow integrations. Also note configuration files for Docker and deployment shows container orchestration.
• Configuration/Deployment: Dockerfiles, compose YAML files, and the devcontainer support that provide containerized environments.
• Documentation & Tests: Although not part of runtime, these show the overall project structure (e.g., “docs” provides architectural and development flow documentation).
Relationships & interactions
• The Workflow Engine interacts with the API and database, managing calibration and execution tasks. You might represent it as a separate module that communicates bidirectionally with both the API and the DB.
• External integration (e.g., Slack notifications) should be shown as an external service that the backend (or workflow engine) calls.
Architectural patterns and design principles
• Layered/MVC Pattern: The separation between API (controller/business logic) and models (database and datamodel) is clear.
• Micro-modular design: The division into submodules (routers, schemas, dbmodel, workflow tasks) shows a separation of concerns.
• Containerization: The presence of Dockerfiles in both the backend and UI, along with compose files, indicates a deployable microservices/containerized environment.
• Extensibility: The workflow plugins and clear CLI division indicate plug-and-play extensibility for new calibration tasks or integrations.
Specific elements
• UI → API: for user requests.
• API ↔ Database: for data persistence.
• API ↔ Workflow Engine: for calibration task management.
• Workflow Engine → External Services: for notifications and integrations.
• Optionally, add notes for configuration details like Docker Compose orchestration and CI/CD pipelines (as indicated by GitHub workflows).