Skip to content

MortyQ/MuzaKit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

229 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 MuzaKit

Where inspiration meets development

A modern, production-ready Vue 3 starter template with glassmorphism design

Vue 3 TypeScript Vite Tailwind CSS

Live Demo β€’ Documentation β€’ Examples


✨ Features

πŸš€ Modern Stack

  • Vue 3 with Composition API and <script setup> syntax
  • TypeScript for type-safe development
  • Vite for lightning-fast HMR and optimized builds
  • Pinia for intuitive state management
  • Vue Router with type-safe routing and lazy loading

🎨 Beautiful Design System

  • Glassmorphism UI with multi-layered shadows and backdrop blur
  • Light/Dark Theme with seamless switching
  • CSS Variables based theming system
  • Responsive Design mobile-first approach
  • 50+ Reusable Components ready to use

πŸ› οΈ Developer Experience

  • ESLint + Prettier configured for modern development
  • Husky git hooks for code quality
  • Feature-based Architecture for scalability
  • Comprehensive Documentation for all components
  • Type-safe Everything with full TypeScript support

πŸ“¦ Production Ready

  • Optimized Build with Vite's tree-shaking
  • Code Splitting for optimal performance
  • SEO Friendly with meta tags support
  • PWA Ready (optional)
  • Deploy Anywhere Vercel, Netlify, or any static host

πŸš€ Quick Start

Prerequisites

  • Node.js 18+ and npm/pnpm

Installation

# Clone the repository
git clone <your-repo-url>
cd muzakit

# Install dependencies
npm install
# or
pnpm install

# Start development server
npm run dev

Open http://localhost:3001 to view your app.


πŸ“‚ Project Structure

muzakit/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/              # Application core
β”‚   β”‚   β”œβ”€β”€ layouts/      # Layout components
β”‚   β”‚   └── router/       # Routing configuration
β”‚   β”œβ”€β”€ features/         # Feature modules
β”‚   β”‚   β”œβ”€β”€ auth/         # Authentication feature
β”‚   β”‚   └── theme/        # Theme management
β”‚   β”œβ”€β”€ pages/            # Page components
β”‚   β”œβ”€β”€ widgets/          # Complex UI widgets
β”‚   β”‚   β”œβ”€β”€ sidebar/      # Sidebar widget
β”‚   β”‚   └── table/        # Data table widget
β”‚   β”œβ”€β”€ shared/           # Shared resources
β”‚   β”‚   β”œβ”€β”€ ui/           # Reusable UI components
β”‚   β”‚   β”œβ”€β”€ composables/  # Vue composables
β”‚   β”‚   └── utils/        # Utility functions
β”‚   └── main.ts           # Application entry
β”œβ”€β”€ public/               # Static assets
└── docs/                 # Documentation

🎨 Glassmorphism Design

MuzaKit features a modern glassmorphism design system with:

Available Glass Utilities

<!-- Basic glass effect -->
<div class="glass">...</div>

<!-- Strong glass (more opaque) -->
<div class="glass-strong">...</div>

<!-- Glass cards -->
<VCard variant="glass">...</VCard>
<VCard variant="glass-elevated">...</VCard>

Automatic Light/Dark Theme

All glass effects automatically adjust for light and dark themes:

  • Light Theme: Subtle purple/blue shadows
  • Dark Theme: Glowing blue shadows for visibility

Mobile Optimization

Glass effects are conditionally applied:

  • Desktop: Full glassmorphism with backdrop blur
  • Mobile: Simplified for better performance

🧩 Key Components

UI Components

  • VButton - Versatile button component
  • VCard - Card with multiple variants (default, elevated, glass)
  • VModal - Accessible modal dialogs
  • VInput - Form input with validation
  • VTable - Feature-rich data table
  • VIcon - Icon component with MDI support
  • VToast - Toast notifications

Widgets

  • Sidebar - Collapsible navigation sidebar
  • Table - Advanced data table with sorting, filtering, pagination
  • Header - Application header with theme toggle

Features

  • Theme System - Light/Dark mode with CSS variables
  • Authentication - Auth guards and state management example
  • Form Validation - Built-in validation utilities

πŸ“š Documentation

Visit the UI Gallery page in the app to see all components with interactive examples.

Component Documentation

Design Guidelines


πŸ› οΈ Scripts

# Development
npm run dev          # Start dev server

# Build
npm run build        # Build for production
npm run preview      # Preview production build

# Code Quality
npm run lint         # Lint and fix code
npm run lint:check   # Check linting only
npm run format       # Format with Prettier

🎯 Roadmap

  • Component Storybook
  • E2E Testing setup
  • More UI components
  • CLI for component generation
  • Theme builder tool

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.


πŸ“ License

MIT License - feel free to use this template for your projects!


πŸ’¬ Support


Built with ❀️ and inspired by creativity

MuzaKit - Your muse for building beautiful interfaces

⬆ back to top

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors