Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ianaya89/generator-vue-component

📦 Yeoman generator to build your own Vue.js components
https://github.com/ianaya89/generator-vue-component

component generator vue yeoaman

Last synced: 2 months ago
JSON representation

📦 Yeoman generator to build your own Vue.js components

Host: GitHub
URL: https://github.com/ianaya89/generator-vue-component
Owner: ianaya89
License: mit
Created: 2016-10-28T00:42:47.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2017-07-18T02:50:47.000Z (over 7 years ago)
Last Synced: 2024-10-12T09:06:58.276Z (3 months ago)
Topics: component, generator, vue, yeoaman
Language: JavaScript
Homepage:
Size: 1.06 MB
Stars: 32
Watchers: 2
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # generator-vue-component

> 📦 Yeoman generator to build your own [Vue.js](http://vuejs.org/) components

[![bitHound Overall Score](https://www.bithound.io/github/ianaya89/generator-vue-component/badges/score.svg)](https://www.bithound.io/github/ianaya89/generator-vue-component)

[![bitHound Dependencies](https://www.bithound.io/github/ianaya89/generator-vue-component/badges/dependencies.svg)](https://www.bithound.io/github/ianaya89/generator-vue-component/master/dependencies/npm)

[![bitHound Dev Dependencies](https://www.bithound.io/github/ianaya89/generator-vue-component/badges/devDependencies.svg)](https://www.bithound.io/github/ianaya89/generator-vue-component/master/dependencies/npm)

[![bitHound Code](https://www.bithound.io/github/ianaya89/generator-vue-component/badges/code.svg)](https://www.bithound.io/github/ianaya89/generator-vue-component)



  



## Support

- Vue.js 2 => `generator-vue-component@>=2.0.0` [master]

- Vue.js 1 => `[email protected]`

## Installation

1. First, install [Yeoman](http://yeoman.io) and generator-vue-component using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash

$ npm install -g yo

$ npm install -g generator-vue-component

```

2. Create your project directory and access it.

```bash

$ mkdir my-awesome-component

$ cd my-awesome-component

```

3. Then generate your new project:

```bash

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

```bash

# 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](https://github.com/ndelvalle/vue-esc/blob/master/LICENSE)

## Style

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](http://standardjs.com)

**⌨️ with ❤️ by [@ianaya89](https://twitter.com/ianaya89)**