Skip to content

INGCapaDev/blog-design-system-storybook-tw

Repository files navigation

🎨 React Design System with Storybook & Tailwind

A modern, scalable design system built with React, TypeScript, Storybook, and Tailwind CSS. This project demonstrates how to create a robust component library using best practices and industry-standard tools.

🥃 Preview

Storybook Preview

✨ Features

  • 🛠️ Built with Vite + React + TypeScript
  • 🎨 Styled with Tailwind CSS
  • 📚 Documented with Storybook
  • 🧬 Organized using Atomic Design principles
  • 💪 Type-safe component variants with CVA
  • 🔍 Comprehensive component documentation
  • 🎯 Best practices and patterns included

🚀 Quick Start

Clone this repository to your local machine using Git.

Command Action
pnpm install Installs dependencies
pnpm dev Starts local dev server at localhost:5173
pnpm storybook Start storybook at localhost:6006

📦 Tech Stack

🗂️ Project Structure

src/
├── components/
│   └── design-system/
│       ├── atoms/          # Basic building blocks
│       ├── molecules/      # Simple compositions
│       └── organisms/      # Complex compositions
├── lib/
│   └── utils.ts           # Utility functions
└── css/
    └── design-tokens.css  # Design tokens

💎 Design Tokens

Our design system uses custom design tokens for consistent styling:

@theme {
  --color-primary: #c1d8c3; /* Soft sage green */
  --color-secondary: #6a9c89; /* Deep teal */
  --color-accent: #ffa725; /* Vibrant orange */
  --color-background: #fff5e4; /* Warm white */
}

🧩 Components

Heading Component

A flexible, type-safe heading component with multiple variants:

<Heading level="h2" variant="accent" size="2xl" align="center">
  Featured Section
</Heading>

Available props:

  • level: h1-h6
  • variant: default | accent
  • size: sm | base | lg | xl | 2xl | 3xl | 4xl
  • align: left | center | right

📚 Documentation

Each component is thoroughly documented in Storybook with:

  • Interactive examples
  • Props documentation
  • Usage guidelines
  • Accessibility information

🤝 Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

🔗 Links


Built with ❤️ by INGCapaDEV

About

A design system example for my blog post built with Storybook and Tailwind in React + Vite

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published