Vue HelioSync Library Documentation

Overview

Vue HelioSync Library is a modular and performant component library for Vue 3. Designed to streamline development with reusable components, it supports TypeScript, TailwindCSS, and interactive documentation using Storybook.

Features

• Vue 3 Compatible: Build applications with the latest Vue features.
• TypeScript Support: Ensure code safety with type checking.
• Storybook Integration: Visualize and interact with components in an isolated environment.
• TailwindCSS: Easily style components with modern utility-first CSS.
• CI/CD Ready: Automated testing, linting, building, and deployment through GitLab pipelines.

Installation

Install the library using npm:

npm install helio-library

Usage

Import and use components in your Vue 3 project:

<template>
  <MyComponent :prop="value" />
</template>

<script setup>
import MyComponent from 'helio-library';
</script>

Development

Prerequisites

Ensure the following are installed:

• Node.js (v16 or later)
• npm

Setup

Clone the repository and install dependencies:

git clone https://gitlab.com/helio-library.git
cd helio-library
npm install

Available Scripts

• npm run dev: Start the development server.
• npm run build: Build the library for production.
• npm run test: Run unit tests using Vitest.
• npm run lint: Check for code quality issues.
• npm run format: Automatically format the code with Prettier.
• npm run storybook: Launch Storybook to preview components.
• npm run build-storybook: Generate a static build of Storybook.

CI/CD Pipeline

Pipeline Stages

1. Test:

   • Runs unit tests with Vitest.
   • Artifacts include test reports and coverage data.

2. Lint:

   • Ensures code quality with ESLint.

3. Build:

   • Compiles the library using Vite and Vue TypeScript Compiler.

4. Storybook:

   • Generates Storybook static files for component documentation.

5. Release:

   • Publishes the library to npm if on the main branch.

Contributing

We welcome contributions! Follow these steps:

1. Fork the repository.
2. Clone your fork locally.
3. Create a new branch for your feature or fix.
4. Make changes and commit them.
5. Submit a pull request to the develop repository.

License

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

For more information, refer to the official documentation or contact the maintainers on GitLab.