@jackdomleo7/vue3-library

A Vue3 component library for my own enjoyment, learning, & development (feel free to use but use at your own risk, this is fully typed and thoroughly tested but was never intended to be used for commercial use).

Tech Stack

Client: Vue3, Vite, TypeScript, Vitest, Storybook, Rollup, pnpm

Installation

Install @jackdomleo7/vue3-library

  npm install @jackdomleo7/vue3-library
  yarn add @jackdomleo7/vue3-library
  pnpm add @jackdomleo7/vue3-library

Usage/Examples

Basic usage

App.vue

import '@jackdomleo7/vue3-library/dist/style.css';

Any component

import ComponentName from '@jackdomleo7/vue3-library/ComponentName.vue';

Run Locally

Clone the project

  git clone https://github.com/jackdomleo7/Vue3_Component_Library

Go to the project directory

  cd Vue3_Component_Library

Install dependencies (You will need pnpm)

  npm i -g pnpm
  pnpm i

Serve Storybook

  pnpm run serve

Serve static Storybook

  pnpm run serve:static

Build static Storybook docs

  pnpm run build:docs

Build the project

  pnpm run build

Run test suite in a single run

  pnpm run test

Open unit test report in the browser

  pnpm run test:report

Add a new component to the library

  pnpm run new-component MyComponent