Duck UI

Welcome to Duck UI, a modern UI component library designed for flexibility and ease of use. This library provides a set of high-quality React components, styled with a clean and responsive design, perfect for building user interfaces in web applications.

🚀 Features

• Modern Design: Elegant and customizable components that adhere to modern UI/UX principles.
• Flexible: Easily integrate and customize components to fit your design needs.
• Themed Styling: Built with a palette that includes black and white, and customizable color options for various themes.
• Well-documented: Comprehensive documentation to help you get started and make the most of Duck UI.

📦 Installation

To get started with Duck UI, install it via npm or yarn:

npm install @ahmedayob/duck-ui

or

yarn add @ahmedayob/duck-ui

📘 Usage

Here's a basic example of how to use Duck UI components in your React application:

import React from 'react'
import { Button, Card } from '@ahmedayob/duck-ui'

const App = () => {
  return (
    <div>
      <Card>
        <h1>Welcome to Duck UI</h1>
        <Button>Click Me!</Button>
      </Card>
    </div>
  )
}

export default App

🛠️ Development

To develop and build the library locally, follow these steps:

1. Clone the Repository

   git clone https://github.com/your-org/duck-ui.git
   cd duck-ui

2. Install Dependencies

   pnpm install

3. Run Development Server

   pnpm dev

4. Build the Library

   pnpm build

🔧 Configuration

Duck UI is configured with Vite for a fast development experience and optimized builds. To customize the configuration, modify the vite.config.ts file.

🧪 Testing

Duck UI uses Vitest for testing. To run the tests, use:

pnpm test

📄 Contributing

We welcome contributions to Duck UI! To contribute, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them with clear messages.
4. Open a pull request with a description of your changes.

📝 License

Duck UI is licensed under the MIT License.

📧 Contact

For any questions or support, please contact us at [email protected].

Thank you for using Duck UI! We hope it helps you build beautiful and functional user interfaces.