⚠️ This package is abandoned in favor of Vue Cli3 ⚠️
Refer to its documentation for creating new Vue packages
Vue package ES6 boilerplate
This is a simple boilerplate for your next Vue plugin.
Table of contents:
Installation
$ npm install -g vue-cli
$ vue init DCzajkowski/vue-package-template my-package
$ cd my-package
$ yarn # or npm install
- Write your package code in
src/main.js - Open
package.jsonfile. Find (all) and replace following keys:package-git-url- Full url to the git folder, e.g. https://github.com/user/package.gitpackage-repo-url- Full url to the repo, e.g. https://github.com/user/package
- Run
npm login - Run
npm publish
How it works
This template uses two different build systems.
NPM usage
All code meant for npm usage is compiled with Webpack. All code goes into dist-module/ folder.
It is ignored by Git, but is being published to npm.
Browser usage
All code meant for browser usage ie. <script> import is compiled with Browserify + Vueify. All code goes to dist/ folder.
It is ignored by Git, but is being published to npm.
Contributing
You are welcome to contribute to this package in any way or form you want. New issues and pull requests are welcome.
I am not a JavaScript expert and some things may not be made in the best way possible. Feel free to point out anything that sticks out.
License
Just use it. For free. Forever.
Issues
If you find any bug or problem with the template please open an issue or create a pull request on the Github repo.