Skip to content

Fully Customizable Tailwind CSS UI Component Library with Advanced Theming Support

License

Notifications You must be signed in to change notification settings

sasikasp/artsovenui

Repository files navigation

Arts Oven UI

Arts Oven UI is an open-source Tailwind CSS component library designed to streamline the development of beautiful, responsive, and accessible web interfaces. With customizable components and advanced theming options, Arts Oven UI empowers developers to build modern applications quickly and efficiently.

Features

  • Customizable Components: A rich set of pre-built components that you can easily customize to fit your project's needs.
  • Advanced Theming: Define and switch between themes effortlessly, enhancing your application's design.
  • Responsive Design: Components that work seamlessly across devices, ensuring a great user experience.
  • Open Source: Licensed under the MIT License, making it free for everyone to use, modify, and distribute.

Installation

To use Arts Oven UI in your project, follow these steps:

  1. Install via npm:

    npm i arts-oven-ui
    
  2. Include the library in your Tailwind CSS configuration:

    // tailwind.config.js
    module.exports = {
       content: ['./src/**/*.{html,js}'],
       theme: {
           extend: {},
       },
       plugins: [require('artsovenui')],
       artsovenui: {
           themes: ['dark', 'light'],
       },
    };
  3. Documentation

Comprehensive documentation is available at docs.artsovenui.com (replace with actual link if available). Here you’ll find guidelines on usage, customization, and examples of components.

  1. Usage:

    <button class="btn-primary">Click Me</button>

Here's a quick example of how to use a button component

  1. Contributing:

We welcome contributions from the community! If you'd like to contribute to Arts Oven UI, please follow these steps:

  1. Fork the repository.

  2. Create a new branch for your feature or bug fix.

  3. Make your changes and commit them.

  4. Push to your fork and submit a pull request.

  5. Support:

Your support is crucial for the continued development and maintenance of Arts Oven UI. Whether through financial contributions, code contributions, or sharing the project with others, every bit helps us grow this library for future generations of developers.

  1. License:

This project is licensed under the MIT License.

  1. Contact:

For questions or feedback, please reach out to us at: artsoven@gmail.com.