Skip to content

vouill/vue-plugin-maker

Repository files navigation

vue-plugin-maker

Template to quickly setup vue plugins

Scaffolded from vue-cli webpack

The main goal of this repo is to help quickly make plugins for various purposes.

You can either adapt an existing vanilla js library or make a vue components library/plugin for your projects.

Usage ?

Code your library/plugin

Code your library/plugin in src/plugin

Build the library

  • npm run build:lib

Creates a lib folder with the plugin/lib inside. You can then name your project, upload it to npm and simply import your components from it. You can change and customize the library build in build/webpack.lib.conf.js

Build the Github docs

  • npm run build:docs

Creates a docs folder with main.js entry project. It's basically a prod build for github pages docs folder.

Link to Docs

Commands

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for plugin file
npm run build:lib

# build for github docs page
npm run build:docs

# run all tests
npm test

# run unit in watch mode
npm run test-watch

For detailed explanation on how things work, checkout the guide and docs for vue-loader.

About

Basic configuration to easily generate vue plugins

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors