# vue-validator

**Repository Path**: kaohongshu2017_admin_admin_admin/vue-validator

## Basic Information

- **Project Name**: vue-validator
- **Description**: :white_check_mark: Validator component for Vue.js
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-03-22
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vue-validator

[![CircleCI Status](https://circleci.com/gh/kazupon/vue-validator/tree/dev.svg?style=shield&circle-token=36fad1862fbb44da91a28217df8fba769d6d1ce7)](https://circleci.com/gh/kazupon/vue-validator/tree/dev)
[![Coverage Status](https://coveralls.io/repos/github/kazupon/vue-validator/badge.svg?branch=dev)](https://coveralls.io/github/kazupon/vue-validator?branch=dev)
[![npm package](https://img.shields.io/npm/v/vue-validator.svg)](https://www.npmjs.com/package/vue-validator)

Validator component for Vue.js

>:warning: NOTE: official release for Vue.js 2.0 not yet :construction:

## :warning: NOTICE !!
`vue-validator` have retiring from vue.js official plugins. in the future, `vue-validator` is continuing as personal project.

## :ok: Compatibility
- v2 later
    - Vue.js `1.0.20`+
- v3 alpha (**WIP** :construction:)
    - Vue.js `2.0.3` later

## :book: Documentation
- v2 later
    - See [here](http://kazupon.github.io/vue-validator/)
- v3
    - **WIP** :construction: [here](https://kazupon.github.io/vue-validator/)

## :star: Projects
- v2: (maintance: https://github.com/kazupon/vue-validator/projects/1)
- v3: (for 3.0 release: https://github.com/kazupon/vue-validator/projects/2)

## :muscle: Contributing
- Fork it !
- Create your top branch from `2.x`: `git branch my-new-topic origin/dev`
- Commit your changes: `git commit -am 'Add some topic'`
- Push to the branch: `git push origin my-new-topic`
- Submit a pull request to `2.x` branch of `kazupon/vue-validator` repository !

### :leaves: Branch
- dev (developement branch for v3 later)
- 2.x (maintance branch for v2 later)


## :hammer: Development Setup

    # install deps
    npm install

    # build dist files
    npm run build

    # lint
    npm run lint

    # run unit tests only
    npm run unit

    # run e2e tests only
    npm run e2e

    # lint & run all tests
    npm test


## :exclamation: Issues

Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.


## :rocket: Contribution

Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md) before making a pull request.


## :scroll: Changelog

Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/vue-validator/blob/dev/CHANGELOG.md).


## :copyright: License

[MIT](http://opensource.org/licenses/MIT)