How patched-network/vue-skuilder works
Main Components Identification
• "Vue SPA Frontend" (located in packages/platform-ui): This is the primary client-side application, built with Vue 3 and Vuetify 3.
• "Express API" (located in packages/express): A Node.js server that handles backend logic, routing, and API requests.
• "CouchDB Database": The storage layer (with local development support via Docker) that stores the application data and supports replication.
• Helper Packages:
• "common" – Contains core interfaces and logic that define application-wide contracts.
• "common-ui" – Holds reusable UI components shared between the platform and standalone course contexts.
• "courses" – Contains domain-specific and generic course logic, questions, and components.
• "db" – Implements interfaces for data access and CouchDB communication via PouchDB.
Relationships and Interactions
• Deployment scripts or build tooling on the periphery if needed (e.g., indicating automated deployment pipelines for the Express service and the Vue frontend).
• Optionally, note that the “courses” package is critical for course management and content inheritance.
Architectural Patterns and Design Principles
• Separation of concerns: the Frontend (presentation layer) is decoupled from the Backend (business logic) through clearly defined API endpoints.
• The use of a monorepo suggests an emphasis on code reuse across components (via the shared packages such as common, common-ui, courses, and db).
• Potential domain-specific patterns (e.g., self-healing courses, expert system guides) that are supported by the well-defined modular packages.
Relevant Technologies and Frameworks
• Frontend: Vue 3, Vuetify 3.
• Backend: Node.js (Express), and possibly additional libraries for logging (as seen in packages/express/src/logger.ts) and routing.
• Storage: CouchDB with local replication supported, alongside PouchDB in the “db” package.
• Build and deployment: Yarn (v4), Docker (for CouchDB), and CI/CD workflows defined in GitHub Actions (as seen in .github/workflows).