examples/sample-app/README.md
# Vue Preferences - Sample App
<p align="center">
<img src="https://user-images.githubusercontent.com/11605133/56131403-aec11f00-5f5d-11e9-8df7-ce60eda7dfa7.png" height="150px">
<p align="center">
This sample app is to introduce you to the vue-preferences library. The goal is to show you possible case uses and ways of using it.
<p>
</p>
## Quick start
First, give it a `live` try, this sample app is already running, [check it out!](https://vue-preferences.netlify.com/)
🙏 We promise the best effort to update this app every time a new feature is released, but can't guarantee so.
#
## Run it on your local machine
First, clone the repository:
```
git clone https://github.com/streaver/vue-preferences.git
```
Then, make sure you are in the right folder:
```
cd vue-preferences/examples/sample-app
```
After that, you are ready to setup the project
### Project setup
```
yarn install
```
#### Compiles and hot-reloads for development
```
yarn run serve
```
#### Compiles and minifies for production
```
yarn run build
```
#### Run your tests
```
yarn run test
```
#### Lints and fixes files
```
yarn run lint
```