Scrubbed Tailwind Components v2

Scrubbed Tailwind Components v2 is a Vue 3 component library that provides a set of pre-built and beautifully styled components using Tailwind CSS. This library is designed to help you quickly build modern and responsive user interfaces.

Installation

To use Scrubbed Tailwind Components v2 in your project, you can install it via npm:

npm install scrubbed-tailwind-components-v2

Usage

You can import and use the components in your Vue application like this:

<script setup>
  import { Button } from "scrubbed-tailwind-components-v2";
</script>

<template>
  <Button>Click me</Button>
</template>

Development

This project uses Vite for development and building.

Recommended IDE Setup

• VSCode
• Volar (and disable Vetur)

Project Setup

To set up the development environment, clone the repository and install the dependencies:

git clone https://[your-username]@bitbucket.org/devteam_scrubbed/scrubbed-tailwind-components-v2.git
cd scrubbed-tailwind-components-v2
npm install

Compile and Hot-Reload for Development

To start the development server with hot-reloading, run the following command:

npm run dev

Compile and Minify for Production

To build the library for production, run:

npm run build

Testing

This project uses Cypress for both component and end-to-end testing.

• Run component tests (headless):

  npm run test:unit

• Run component tests (headed):

  npm run test:unit:dev

• Run end-to-end tests (headless):

  npm run test:e2e

• Run end-to-end tests (headed):

  npm run test:e2e:dev