How aziontech/azion-webkit works
Project Type & Purpose
• This is an open-source front-end component and templating toolkit (“azion-webkit”) built with Vue.
• It provides reusable Vue components, template “blocks,” mock data, styles, and Storybook stories so that teams can quickly assemble pages or apps.
• It is shipped as an npm package and published via CI/CD (GitHub Actions).
High-Level File Structure
• src/
• App.vue, main.js – entry point for the demo/gallery application.
• helpers/ – utility functions.
• mock/ – data fixtures for Storybook and examples.
• services/ – integrations (HubSpot, newsletter).
• stories/ – Storybook MDX and JS stories organizing components and templates.
• templates/ – dozens of individual Vue component packages (one per folder) representing atomic UI “blocks.”
• public/, index.html – static assets and HTML host for demos/Storybook.
• build.js, vite.config.js, postcss.config.js, tailwind.config.js – build and bundler configuration.
• dist/ – compiled output and package.json for publishing.
• .github/workflows/ – CI pipelines: release (npm publish) and Storybook build.
README Insights
• Describes installation (npm install azion-webkit), usage in other projects, and reliance on Storybook for visual QA.
• Developer Workstation
– Source code (src/, templates/, stories/)
– Local Storybook server (npm run storybook)
– Local dev server (npm run dev via Vite)
• Build & CI/CD
– Vite/Rollup build.js + PostCSS/Tailwind
– GitHub Actions workflows: storybook build, release→ npm registry
• Package Registry (npm)
• Consumer Application
– Imports azion-webkit from npm
– Bundles via consumer’s bundler (e.g. Webpack, Vite)
– Renders Vue components, loads CSS/assets
• External Services
– HubSpot (via hubspot-service.js)
– Newsletter API (newsletterSubmitHandler.js)
• Dev workstation → Build pipeline (push to GitHub)
• CI workflow → publishes to npm registry
• Consumer app → installs from npm → bundler → browser
• Components → call services → external APIs
c. Architectural Patterns & Principles
• Atomic/“block”-based component design – each src/templates subfolder is a self-contained package.
• Storybook-driven development – stories mirror templates for visual testing.
• Mono-repo style packaging – one repo, multiple light packages under templates/.
• Separation of concerns – helpers, mocks, services, and templates clearly partitioned.
d. Key Technologies & Frameworks
• Vue 3 Single-File Components
• Vite (dev server, build) / Rollup plugin in build.js
• Tailwind CSS + PostCSS
• Storybook for Vue
• GitHub Actions for CI/CD
• Node.js/npm for package management
Diagramming Recommendations
• Blue: source & dev tools (Vue, Storybook, Vite)
• Green: build & CI (GitHub Actions, Rollup)
• Orange: runtime / consumer app
• Gray: external APIs
• Optionally, annotate package boundaries (e.g., template sub-packages beneath “core library”).