https://github.com/shubhadip/vue3-component-library

This is a template for building vue components library.Project makes use of vue3.0 with rollup configuration to build treeshakable imports and Postcss for compilation of css
https://github.com/shubhadip/vue3-component-library

component-library library library-boilerplate postcss rollup rollupjs starter-template typescript vue vue3 vue3-project vuejs

Last synced: 11 days ago
JSON representation

This is a template for building vue components library.Project makes use of vue3.0 with rollup configuration to build treeshakable imports and Postcss for compilation of css

• Host: GitHub
• URL: https://github.com/shubhadip/vue3-component-library
• Owner: shubhadip
• Created: 2020-10-23T06:17:30.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-05T03:52:39.000Z (almost 3 years ago)
• Last Synced: 2024-10-11T12:51:49.239Z (27 days ago)
• Topics: component-library, library, library-boilerplate, postcss, rollup, rollupjs, starter-template, typescript, vue, vue3, vue3-project, vuejs
• Language: JavaScript
• Homepage:
• Size: 992 KB
• Stars: 86
• Watchers: 5
• Forks: 30
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue 3 Component Library BoilerPlate

**Technology Used:**\

[Vuejs 3.0](https://github.com/vuejs/vue-next)\

[Typescript](https://github.com/microsoft/TypeScript)\

[Rollup](https://github.com/rollup/rollup)

## Project setup

Please follow below mentioned step to run this project:

- Clone the repo

```shell

https://github.com/shubhadip/vue3-component-library

```

### Run

```

yarn install

```

### Compiles and hot-reloads for development

```

yarn serve

```

### Compiles and minifies for production

```

yarn build

```

### Build Library

```

yarn build:js

```

### Build Library With Separate Css file

```

yarn build:js_css

```

### Lints and fixes files

```

yarn lint

```

## Usage Of Components Built

**As Component**

```

  import { TestWorld } from 'vue3-component-library/dist/esm/testworld';

  ...

  components:{

    TestWorld

  }

```

**As Plugin**

```

  import { TestWorld } from 'vue3-component-library';

    ...

  app.use(TestWorld)

```