Skip to content
This repository has been archived by the owner on Apr 1, 2019. It is now read-only.

Commit

Permalink
add readme and meta
Browse files Browse the repository at this point in the history
  • Loading branch information
Walker Leite committed Sep 12, 2017
1 parent 3cca37c commit 130bd0c
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# vue-standalone-component
Vuejs standalone component template using karma for testing

> Build your standalone components using this tiny template.
> This template is Vue 2.x **only**.
### Usage

This is a project template for [vue-cli](https://github.com/vuejs/vue-cli).

``` bash
$ npm install -g vue-cli
$ vue init InCuca/vue-standalone-component my-component
$ cd my-component
$ npm run dev
```

The generated output in ./dist can be used with node and the browser.

### What's Included

- Gulp tasks for development building, testing and development server
- Karma for testing

### Testing

``` bash
$ npm test
```

### Building to ./build

``` bash
$ npm run build
``
21 changes: 21 additions & 0 deletions meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"prompts": {
"name": {
"type": "string",
"required": true,
"label": "Component name in kebab-case format",
"default": "v-awesome-component"
},
"description": {
"type": "string",
"required": true,
"label": "Project description",
"default": "A Vue.js component"
},
"author": {
"type": "string",
"label": "Author"
}
},
"completeMessage": "To get started:\n\n{{^inPlace}}cd {{destDirName}}\n\n{{/inPlace}}1. Write your component in src/Component.vue\n2. Write a demo in src/demo.vue\n3. npm run dev\n4. npm run dist\n5. npm run dist:demo\n6. npm run demo:open"
}

0 comments on commit 130bd0c

Please sign in to comment.