SmoothUI

SmoothUI is a collection of beautifully designed components with smooth animations built with React, Tailwind CSS, and Motion. This project aims to provide developers with a set of reusable UI components that enhance user experience through delightful animations and modern design patterns.

Table of Contents

• SmoothUI
  • Table of Contents
  • Features
  • Installation
  • Usage
  • Contributing
  • License

Features

• Smooth Animations: Built-in animations powered by Motion for delightful user experiences.
• Responsive Design: Fully responsive components designed with Tailwind CSS.
• Easy to Use: Simple API for integrating components into your projects.
• Customizable: Tailwind CSS utility classes allow for easy customization of styles.
• Dark Mode Support: Components support both light and dark themes out of the box.

Installation

To use SmoothUI components, you will need to install the following dependencies:

pnpm install motion tailwindcss lucide-react clsx tailwind-merge

Usage

After installing the dependencies, you can start using SmoothUI components in your React application. Here’s an example of how to use a component:

import MyNewComponent from "@/app/doc/_components/ui/MyNewComponent";
const App = () => {
    return (
        <div>
            <MyNewComponent />
        </div>
    );
};
export default App;

Contributing

Thank you for your interest in contributing to SmoothUI! Please follow these steps to contribute:

1. Fork the Repository: Click the "Fork" button in the top right corner of the page.
2. Clone Your Fork: Run the following command to clone your forked repository to your local machine:

   git clone https://github.com/yourusername/smoothui.git

3. Create a New Branch: Create a new branch for your feature or bug fix:

   git checkout -b my-feature

4. Make Your Changes: Implement your changes and commit them with a descriptive message:

   git commit -m "Add my feature"

5. Push Your Changes: Push your changes to your forked repository:

   git push origin my-feature

6. Create a Pull Request: Go to the original SmoothUI repository on GitHub and click on the "Pull Requests" tab. Click the "New Pull Request" button and select your forked repository and branch.

License

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

---

Thank you for contributing to SmoothUI! We appreciate your help in making this project better. If you have any questions, feel free to reach out to the maintainers.