# Vuex [![Build Status](https://img.shields.io/circleci/project/vuejs/vuex/master.svg)](https://circleci.com/gh/vuejs/vuex) [![npm package](https://img.shields.io/npm/v/vuex.svg)](https://www.npmjs.com/package/vuex)

> Flux-inspired Application Architecture for Vue.js.

<p align="center">
  <img width="700px" src="https://raw.githubusercontent.com/vuejs/vuex/master/docs/en/vuex.png">
</p>

- [Documentation](http://vuejs.github.io/vuex/)
- [Great introduction and explanation by @skyronic](http://skyronic.com/2016/01/03/vuex-basics-tutorial/) (using outdated 0.3.0 API, but still worth a read!)
- [Vuex introduction video - James Browne from London Vue.js Meetup #1](https://www.youtube.com/watch?v=l1KHL-TX3qs)
- [Feathers.js example using Vue.js and Vuex on the client to maintain state](https://github.com/niallobrien/feathers-chat-example) by [Niall O'Brien](https://github.com/niallobrien) (Twitter: [@niall_obrien](https://twitter.com/niall_obrien))

## Examples

- [Counter](https://github.com/vuejs/vuex/tree/master/examples/counter)
- [Counter with Hot Reload](https://github.com/vuejs/vuex/tree/master/examples/counter-hot)
- [TodoMVC](https://github.com/vuejs/vuex/tree/master/examples/todomvc)
- [Flux Chat](https://github.com/vuejs/vuex/tree/master/examples/chat)
- [Shopping Cart](https://github.com/vuejs/vuex/tree/master/examples/shopping-cart)

Running the examples:

``` bash
$ npm install
$ npm run counter # run the counter example
```

See [npm scripts](https://github.com/vuejs/vuex/blob/master/package.json#L11-L15) for all example npm scripts.

## Principles

- Terse
- Testable
- Reactive
- Single State Tree
- Hot Reloading
- Time Travel (with [vue-devtools](https://github.com/vuejs/vue-devtools) support)

## License

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