How 3yourmind/kotti works
Main Components
• Core Packages – Highlight the primary UI component package (“kotti-ui”), along with other packages like “yoco” and “vue-use-tippy” that extend or support the core functionality.
• Documentation Module – Represent the Nuxt-managed documentation site (packages/documentation) as an independent but integrated component.
• Build & Configuration Tools – Include components for internal scripts (internals/), turborepo/lerna configuration files, and continuous integration workflows (.github/workflows).
• Shared Assets & Utilities – Display the shared components such as style tokens (packages/kotti-ui/tokens), ESLint and stylelint configuration (packages/eslint-config), and TypeScript configurations.
• How each package or module relates:
• The UI components library (kotti-ui) being the heart of the system, which exports Vue components that are consumed by user applications.
• The supporting packages (“yoco” and “vue-use-tippy”) are dependencies for additional utility or styling purposes and are designed to be used alongside or within the core Kotti UI.
• The documentation site (built with Nuxt) serves as an interface for learning and demonstrating the usage of the UI components.
• The internal tooling (located under internals/ and configuration files like turbo.json, lerna.json) manages dependency bootstrapping and build orchestration among the packages.
Architectural Patterns and Design Principles
• Modular Monorepo Architecture – Clearly separate each package as its own module with its own configuration files and build scripts, but also indicate how they are unified under a common build toolchain (turborepo/lerna).
• Component-Based UI – Emphasize that the architectural goal is a consistent, fail-fast UI framework built using Vue (evident by the large number of Vue component files in packages/kotti-ui).
• Separation of Concerns – Show that there is a clear divide between UI components, documentation, configuration, and tooling.
• Automated CI/CD and Release Pipelines – Indicate that GitHub workflows (e.g., publish.yml, ci.yml, gh-pages.yml) are integrated to manage testing, building, and publishing.