How michaelcozzolino/flyonui-vue works
Project type and purpose
• This is a monorepo for a Vue component library (flyonui-vue) built on top of FlyonUI and Tailwind CSS.
• It contains:
• packages/core: the Vue component library itself
• packages/create-flyonui-vue: a CLI scaffolding tool for new Vite+Vue projects that installs and configures flyonui-vue
• packages/docs: a VitePress-based documentation site showcasing components and usage
• packages/web-components: wrappers to ship the same components as framework-agnostic Web Components
File structure
• Top-level configuration:
• package.json, .yarnrc.yml, eslint.config.mjs, vitest.config.ts
• .github/workflows: CI definitions (node.js.yml for test/build, deploy.yml for docs or npm)
• packages/core:
• src/Components: each UI component split into Types, Internal/Lib, and UI (Vue single-file components)
• Configuration utilities under src/Configuration
• Shared code under src/Shared
• Tests in packages/core/tests
• Vite configs for building the library
• packages/create-flyonui-vue:
• src/Templates: a Vue starter template with configs and assets
• index.ts: CLI entry point
• packages/docs:
• .vitepress: site config and custom theme components
• markdown and Vue demos under packages/docs/Components, Forms, etc.
• packages/web-components:
• code to wrap core components as Web Components
README for additional insights
• Describes how to install and use the library in existing projects or scaffold new ones.
• Notes the dependency on FlyonUI and Tailwind CSS.
Elements
• Clear labels (e.g., “packages/core”, “packages/create-flyonui-vue”, “GitHub Actions”, “npm registry”)
• from monorepo root to CI workflows
• from CI workflows to documentation hosting and npm registry
• from core → docs, web-components, CLI
• from CLI → user project
• Rectangles for packages
• Parallelograms for documentation site and generated user projects
• Hexagons or diamonds for CI/CD
Detailed capture of essential elements
• Workspace graph: core at center feeding three consumers (docs, create CLI, web-components).
• CI workflow steps: test core, build packages, lint, deploy docs, publish packages.
• User-journey: developer runs yarn create flyonui-vue → CLI scaffolds a new Vite/Vue project → new project depends on flyonui-vue → project builds and runs with Tailwind CSS.