@kushalsamant/design-template
v1.3.2
Published
Unified design system and component library for KVSHVL projects
Downloads
12
Maintainers
Readme
KVSHVL Design Template
A unified design system and component library based on the Awwwards-winning GKC Architecture & Design pattern. This template provides a consistent, professional design language for all KVSHVL projects.
Features
- Minimal, Clean Aesthetic - Professional design with maximum impact
- Dark Mode Support - System preference detection with manual toggle
- Responsive Design - Mobile-first approach with excellent mobile experience
- Accessibility - WCAG AAA compliant
- Performance - Optimized animations and 60fps performance
- Type-Safe - Full TypeScript support
Installation
As npm Package
npm install @kvshvl/design-templateAs Git Submodule
git submodule add https://github.com/kushalsamant/kvshvl-design-template.git templateQuick Start
1. Install the Package
npm install @kvshvl/design-template2. Import Styles
// app/layout.tsx or _app.tsx
import '@kvshvl/design-template/styles/globals.css'3. Configure Your Site
// config/site.config.ts
import { createSiteConfig } from '@kvshvl/design-template/config'
export const siteConfig = createSiteConfig({
name: 'Your Site Name',
domain: 'yoursite.com',
brandColors: {
primary: '#9333EA',
secondary: '#EC4899',
},
navigation: [
{ href: '/about', label: 'About' },
{ href: '/projects', label: 'Projects' },
],
})4. Use Components
import { Hero, ProjectCard, Button } from '@kvshvl/design-template/components'
export default function Home() {
return (
<>
<Hero
title="Your Site Title"
tagline="Supporting tagline"
cta={{ label: 'Get Started', href: '/start' }}
/>
<ProjectCard
title="Project Name"
description="Project description"
image="/project.jpg"
href="/projects/project"
/>
</>
)
}Components
Layout Components
AppHeader- Sticky header with navigation and theme toggleAppFooter- Footer with organized links and brandingThemeProvider- Theme initialization and scroll animations
Content Components
Hero- Large hero section with title, tagline, and CTAProjectCard- Project/product showcase cardCard- General purpose card componentButton- Button with multiple variantsStatsDisplay- Statistics/metrics displayTestimonial- Quote/testimonial blockNewsCard- Blog/news article cardClientGrid- Client/product logo grid
Utility Components
ThemeToggle- Dark/light/system theme toggleMobileMenu- Mobile navigation menuSection- Section wrapper with consistent spacing
Design System
Typography
- Font Family: Inter (Google Fonts)
- Headings: H1 (4rem-5rem), H2 (3rem-4rem), H3 (1.875rem)
- Body: 1rem base size with relaxed line-height
Colors
- Primary: #9333EA (Purple)
- Secondary: #EC4899 (Pink)
- Gradient: Primary to Secondary
- Full dark mode support with system preference detection
Spacing
- Generous spacing system: xs (8px) to 3xl (64px)
- Section spacing: 4rem-6rem between major sections
Animations
- Smooth transitions (150ms-500ms)
- Scroll-triggered animations
- Hover effects with elevation changes
- Respects
prefers-reduced-motion
Configuration
See CONFIGURATION.md for detailed configuration options.
Documentation
- Components - Complete component API
- Design System - Design tokens and patterns
- Migration Guide - Migrating existing projects
Automatic Updates
This template is designed to automatically update across all projects:
npm Package Method
- Update template repository
- Publish new version:
npm version patch && npm publish - Projects update:
npm update @kvshvl/design-template - Automated via Dependabot/Renovate
Git Submodule Method
- Update template repository
- Projects pull updates:
git submodule update --remote - Can be automated with GitHub Actions
License
See LICENSE file for details.
Support
For issues and questions, please open an issue in the template repository.
