quanta-kit-design-system-angular
v0.0.4
Published
๐ **Techy & Futuristic** - QuantaKit delivers quantized UI elements in an Angular-based toolkit built for scale. With atomic design, blazing performance, and WCAG accessibility, it's your launchpad to consistent, adaptive appsโnow and as Web Components i
Readme
QuantaKit Angular
๐ Techy & Futuristic - QuantaKit delivers quantized UI elements in an Angular-based toolkit built for scale. With atomic design, blazing performance, and WCAG accessibility, it's your launchpad to consistent, adaptive appsโnow and as Web Components in the future.
โจ Features
- โ๏ธ Atomic Design - Components built with atoms, molecules, and organisms
- ๐ Angular 20 - Latest Angular framework with modern architecture
- ๐ Storybook Integration - Interactive component development and documentation
- โฟ WCAG Accessibility - Full accessibility compliance out of the box
- ๐ฏ Performance Optimized - Tree-shakeable, lightweight components
- ๐ฎ Future-Ready - Designed for easy Web Components migration
- ๐จ Themeable - Consistent design system with customization options
- ๐ฑ Responsive - Mobile-first responsive design
๐ ๏ธ Prerequisites
- Node.js (version 22 or higher)
- npm (comes with Node.js)
- Git
๐ฆ Installation
For Library Users
npm install quanta-kit-design-system-angularFor Development
- Clone the repository:
git clone https://github.com/marvin-aroza/quanta-kit-angular.git
cd quanta-kit-angular- Install dependencies:
npm install- Start Storybook (recommended for development):
npm run storybookStorybook will be available at http://localhost:6006.
๐ Quick Start
import { ButtonComponent } from "quanta-kit-design-system-angular";
@Component({
template: ` <qk-button variant="primary" size="medium"> Click me! </qk-button> `,
})
export class MyComponent {}๐๏ธ Available Scripts
npm run storybook- Start Storybook development environmentnpm start- Start Angular development servernpm run build- Build the librarynpm run build-storybook- Build Storybook for productionnpm test- Run unit testsnpm run test-storybook- Run Storybook tests
Development serverta-kit-angular
๐ Techy & Futuristic QuantaKit delivers quantized UI elements in an Angular-based toolkit built for scale. With atomic design, blazing performance, and WCAG accessibility, itโs your launchpad to consistent, adaptive appsโnow and as Web Components in the future.
This project was generated using Angular CLI version 20.1.3.
Development server
๐ Project Structure
projects/quanta-kit/
โโโ src/
โ โโโ lib/ # Component library source
โ โ โโโ atoms/ # Basic building blocks
โ โ โโโ molecules/ # Simple combinations
โ โ โโโ organisms/ # Complex components
โ โโโ public-api.ts # Library exports
โโโ .storybook/ # Storybook configuration
โโโ stories/ # Storybook stories๐จ Component Categories
Atoms
- Button, Input, Label, Icon, etc.
Molecules
- Form Field, Card Header, Navigation Item, etc.
Organisms
- Form, Card, Navigation Bar, etc.
๐ค Contributing
We welcome contributions! Please see our Contributing Guide for details on:
- Component development workflow
- Storybook story creation
- Accessibility requirements
- Testing standards
๐ Documentation
- Storybook: Interactive component playground and documentation
- API Docs: Generated TypeScript documentation
- Usage Guide: QuantaKit Docs
๐ License
This project is private and proprietary.
๐ Related Projects
- Angular Admin Panel - Example implementation
- QuantaKit Docs - Documentation platform
