Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vuex-orm/vuex-orm

The Vuex plugin to enable Object-Relational Mapping access to the Vuex Store.
https://github.com/vuex-orm/vuex-orm

orm vue vuex vuex-orm vuex-plugin

Last synced: 1 day ago
JSON representation

The Vuex plugin to enable Object-Relational Mapping access to the Vuex Store.

Awesome Lists containing this project

README 

        


  Vuex ORM




Vuex ORM





  

    Travis CI

  

  

    codecov

  

  

    npm

  

  

    JavaScript Style Guide

  

  

    License

  




---



:fire: **HEADS UP!** Currently, [Vuex ORM Next](https://github.com/vuex-orm/vuex-orm-next) project is on going, and we are hoping it is going to be the foundation of the version 1.0.0 release. We're not planning to add features to current v0.36.3 due to focusing more on Vuex ORM Next development. If you're new to Vuex ORM, please try out Vuex ORM Next.



---



Vuex ORM is a plugin for [Vuex](https://github.com/vuejs/vuex) to enable Object-Relational Mapping access to the Vuex Store. Vuex ORM lets you create "normalized" data schema within Vuex Store with relationships such as "Has One" and "Belongs To Many" like any other usual ORM library. It also provides fluent API to get, search and update Store state.



Vuex ORM is heavily inspired by Redux recipe of ["Normalizing State Shape"](https://redux.js.org/recipes/structuring-reducers/normalizing-state-shape) and ["Updating Normalized Data"](https://redux.js.org/recipes/structuring-reducers/updating-normalized-data). Learn more about the concept and motivation of Vuex ORM at [What is Vuex ORM?](https://vuex-orm.github.io/vuex-orm/guide/prologue/what-is-vuex-orm.html).



Sponsors



Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:



Super Love Sponsors





  

    Peter Tóth

  

  

    Mario Kolli

  

  

    Cannikan

  

  

    Andy Koch

  

  

    Dylan Copeland

  




Big Love Sponsors





  

    geraldbiggs

  

  

    Cue

  

  

    Kazuya Kawaguchi

  

  

    jShaf

  

  

    ibrainventures

  




A Love Sponsors





  

    George Chaduneli

  

  

    bpuig

  

  

    John

  

  

    mean-cj

  

  

    Jeffrey Soong

  




## Documentation



You can check out the full documentation for Vuex ORM at https://vuex-orm.org.



## Questions & Discussions



Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.



Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/vuex-orm/issues) for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.



## Examples



You can find example applications built using Vuex ORM at;



- [Vuex ORM Examples](https://github.com/vuex-orm/vuex-orm-examples) – Simple ToDo App built on top of a plain Vue structure generated by [Vue CLI](https://cli.vuejs.org/).

- [Vuex ORM Examples Nuxt](https://github.com/vuex-orm/vuex-orm-examples-nuxt) – Simple ToDo App built on top of [Nuxt.js](https://nuxtjs.org/).



## Plugins



Vuex ORM can be extended via plugins to add additional features. Here is a list of available plugins.



- [Vuex ORM Axios](https://github.com/vuex-orm/plugin-axios) – The plugin to sync the store against a RESTful API.

- [Vuex ORM GraphQL](https://github.com/vuex-orm/plugin-graphql) – The plugin to sync the store against a [GraphQL](https://graphql.org) API.

- [Vuex ORM Search](https://github.com/vuex-orm/plugin-search) – The plugin adds a search() method to filter records using fuzzy search logic from the [Fuse.js](http://fusejs.io).

- [Vuex ORM Change Flags](https://github.com/vuex-orm/plugin-change-flags) - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.

- [Vuex ORM Soft Delete](https://github.com/vuex-orm/plugin-soft-delete) – Vuex ORM plugin for adding soft delete feature to model entities.



Also, you can find a list of awesome things related to Vuex ORM at [Awesome Vuex ORM](https://github.com/vuex-orm/awesome-vuex-orm).



## Contribution



We are excited that you are interested in contributing to Vuex ORM! Anything from raising an issue, submitting an idea of a new feature, or making a pull request is welcome! Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.



### Pull Request Guidelines



When submitting a new pull request, please make sure to follow these guidelines:



- **For feature requests:** Checkout a topic branch from `dev` branch, and merge back against `dev` branch.

- **For bug fixes:** Checkout a topic branch from `master` branch, and merge back against `master` branch.



These rules also apply to the documentation. If you're submitting documentation about a new feature that isn't released yet, you must checkout the `dev` branch, but for non-functional updates, such as fixing a typo, you may checkout and commit to the `master` branch.



### Scripts



There are several scripts to help with development.



```bash

$ yarn build

```



Compile files and generate bundles in `dist` directory.



```bash

$ yarn lint

```



Lint files using a rule of Standard JS.



```bash

$ yarn test

```



Run the test using [Jest](https://jestjs.io/).



```bash

$ yarn test:watch

```



Run the test in watch mode.



```bash

$ yarn test:perf

```



Run the performance test.



```bash

$ yarn coverage

```



Generate test coverage in `coverage` directory.



```bash

$ yarn docs

```



Build and boot documentation server with [VuePress](https://vuepress.vuejs.org/).



## License



The Vuex ORM is open-sourced software licensed under the [MIT License](./LICENSE).