generator-vue-component

📦 Yeoman generator to build your own Vue.js components

Support

• Vue.js 2 => generator-vue-component@>=2.0.0 [master]
• Vue.js 1 => generator-vue-component@1.0.0

Installation

1. First, install Yeoman and generator-vue-component using npm (we assume you have pre-installed node.js).

$ npm install -g yo
$ npm install -g generator-vue-component

2. Create your project directory and access it.

$ mkdir my-awesome-component
$ cd my-awesome-component

3. Then generate your new project:

yo vue-component

Scaffolding

└───docs/
    ├───App.vue
    ├───main.js
└───src/
    ├───assets/
        └───vue.png
    ├───HelloWorld.vue
    ├───index.js
├───.babelrc
├───.editorconfig
├───.eslintignore
├───.eslintrc.
├───.gitignore
├───.npmignore
├───LICENSE
├───package.json
├───README.md
├───webpack.config.js

Development Setup

# install dependencies
$ npm install

# dev mode
$ npm run dev

# build component and get production release
$ npm run build

TODO

1. Jest Integration [help wanted 🙏]
2. Docs production build

License

MIT License

Style

⌨️ with ❤️ by @ianaya89