Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 2.21 KB

README.md

File metadata and controls

85 lines (53 loc) · 2.21 KB
Raw

UI Collection for Nuxt 3

This project is a UI component collection built with Nuxt 3 and Vuetify, designed to offer a variety of ready-to-use, elegant UI elements such as cards, carousels, grids, and more. Each component provides CSS-only and Vuetify-based implementations, allowing easy integration and flexibility depending on your project’s requirements.

Features

  • Pre-designed UI Components: Includes a variety of UI elements like cards, carousels, and grids.
  • CSS-only and Vuetify Options: Choose between CSS-only or Vuetify implementations for each component.
  • Elegant and Clean Design: All components are designed for visual consistency and ease of customization.
  • Optimized for Nuxt 3: Fully compatible with Nuxt 3, offering fast and efficient rendering.

Installation

To get started, follow these steps:

  1. Clone the repository:

    git clone https://github.com/oooFreaKooo/UI-Collection.git

  2. Navigate into the project directory:

    cd UI-COLLECTION

  3. Install the dependencies using Yarn:

    yarn

  4. Start the development server:

    yarn dev

Available Components

  • Cards: Multiple card layouts with options for CSS-only and Vuetify implementations.
  • Carousels: Image and content carousels with responsive design.
  • Grids: Customizable grid layouts for displaying content in structured ways.

Usage

After starting the development server, navigate to the desired component in the UI collection to explore its options and usage examples. Each component will have buttons to directly access either the CSS-only or Vuetify version of the component.

Build for Production

To build the application for production:

yarn build

After building, you can start the production server:

yarn start

Linting

To lint your code, run:

yarn lint

To automatically fix linting issues, run:

yarn lint:fix

Contribution

If you'd like to contribute new components or improvements, feel free to open a pull request. We welcome all contributions that help make this UI collection more comprehensive and user-friendly.

License

This project is licensed under the MIT License.