waynecz / vue-component-boilerplate

⚡️ Building / Doc / Demo templates all in one

Holmes: Server boilerplate you might need | Place other links here

Intro

• ( List your features here )
• Bili ( rollup ) for building component in es/cjs/umd ways
• Poi ( webpack ) for running & building demo
• Concise Readme.md template with document inline

Screenshots

Install and Usage

# clone boilerplate
git clone https://github.com/waynecz/vue-component-boilerplate.git example-name

cd example-name

# delete original git files
rm -rf .git

# create new one upon link your repo
git init && git remote add origin {your repo address}

# install dependices
yarn

1. Replace things in package.json with your own

2. Start writting your component and:

   # develop
   npm run dev
   
   # build component
   npm run build
   
   # build demo
   npm run build:demo

API

Name a few APIs here

1. value: Number
   Component's value binded, remember end with two Tabs every line

2. on-when: Function
   params: func ( ...param )
   hook function when ...

Much more APIs

1. more: Boolean
   default: false
   ...

Categorize them

1. categorize: Object
   ...

Other things such as Contribute guide / License / Thanks ...

It's your turn