vueforce/README.md

A Vue.js lightning framework for salesforce

# Vueforce

### What is Vueforce?   
---

Vueforce is a progressive framework base upon [vue.js](https://vuejs.org/) for building user interfaces. Unlike using other framework, vueforce is designed from [lightning design system](https://www.lightningdesignsystem.com/) and the manner of syntax is really like visualforce, so it won't be hard to start for each salesforce developer.

### Getting Started ###
---

The easiest way to try out vueforce is using the [JSFiddle Hello World example](https://jsfiddle.net/EchoesWu/fdzeq0k1).

# Installation
>Detailed release notes for each version are available on [GitHub](https://github.com/EchoesWu/vueforce).

### NPM
---

NPM is the recommended installation method when building your applications with Vueforce. It pairs nicely with module bundlers such as Webpack. And if you want a collection of what it depended, you can find the package.json in its [GitHub](https://github.com/EchoesWu/vueforce)

``` shell
$ npm install vueforce
```

### CDN
---

Recommended: https://unpkg.com/vueforce, which will reflect the latest version as soon as it is published to npm.

``` html
<script src="https://unpkg.com/vueforce"></script>
```

## Build Setup

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

```