Bamboo

Overview

RuiRui is a reusable Component collection designed for Vite and Vue 3. It utilizes TailwindCSS for styling and features comprehensive documentation built with Storybook.

Features

• Reusable Components: RuiRui offers a collection of reusable components that can be easily integrated into Vite and Vue 3 projects.
• TailwindCSS Styling: The components are styled using TailwindCSS, providing a modern and customizable look and feel.
• Comprehensive Documentation: RuiRui comes with detailed documentation built with Storybook, allowing users to easily understand and utilize the components.

Installation

To install RuiRui, you need to have Node.js and npm installed on your machine. If you don’t have them installed, you can download and install them from the official Node.js website.

Once you have Node.js and npm installed, follow these steps:

1. Open your terminal and navigate to your project directory.
2. Run the following command to install the dependencies:

npm install

3. To start the development server and view the documentation, run the following command:

npm run storybook

This will start the Storybook server and open the documentation in your browser at http://localhost:6006.

If you want to build the components for production, use the following command:

npm run build

This will generate the static files in the dist folder.

To build the Storybook documentation for production, run the following command:

npm run build-storybook

This will generate the static files in the docs folder, which can be used to host the documentation on platforms like GitHub Pages.

To run the unit tests, use the following command:

npm run test

To run the linter for code formatting and linting, use the following command:

npm run lint

Summary

RuiRui is a powerful Component collection designed for Vite and Vue 3. With its reusable components, TailwindCSS styling, and comprehensive documentation, developers can easily integrate and customize components in their projects. The installation process is straightforward, and the project also provides tools for building for production, running unit tests, and ensuring code quality with linting. RuiRui is licensed under MIT, making it a flexible and accessible choice for developers.