Skip to content

Latest commit

 

History

History
113 lines (81 loc) · 2.35 KB

README.md

File metadata and controls

113 lines (81 loc) · 2.35 KB

Mixcn-UI

Mixcn-UI Banner

A perfect composition of beautiful components and powerful animations. Mixcn-UI is a modern, responsive UI component library built with React and TypeScript.

🚀 Features

  • 🎨 Beautiful, modern component designs
  • ⚡ Highly performant and lightweight
  • 📱 Fully responsive components
  • 🎭 Powerful animation system
  • 🔧 Easy to customize
  • 📦 Tree-shakeable
  • 🎯 TypeScript support

🛠️ Tech Stack

🚀 Getting Started

First, install the package:

npm install mixcn-ui
# or
yarn add mixcn-ui
# or
pnpm add mixcn-ui

Then, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

📚 Documentation

Visit our documentation to learn more about:

  • Component API
  • Theming
  • Animations
  • Best practices
  • Examples

🤝 Contributing

We love your input! We want to make contributing to Mixcn-UI as easy and transparent as possible. Here's how you can contribute:

  1. Fork the repo

    https://github.com/shadcn/mixcn-ui.git

  2. Clone your fork

    git clone https://github.com/your-username/mixcn-ui.git

  3. Create your feature branch

    git checkout -b feature/AmazingFeature

  4. Make your changes and commit

    git commit -m 'Add some AmazingFeature'

  5. Push to the branch

    git push origin feature/AmazingFeature

  6. Open a Pull Request

Development Guidelines

  • Follow the existing code style
  • Write meaningful commit messages
  • Add tests for new features
  • Update documentation as needed
  • Ensure all tests pass before submitting PR

📄 License

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

💖 Credits

Built with love by Md Taqui Imam

🤝 Support

Made with ❤️ by the Mixcn-UI team