Skip to content
master
Switch branches/tags
Code

Vuex ORM

Vuex ORM Plugin: Axios

npm Travis CI codecov License

Vuex ORM Axios plugin adds smooth integration between API requests and Vuex ORM data persistence through the awesome axios.

If you use axios with Vuex ORM, you may find handling requests can become an arduous and repetitive process. This plugin bridges Vuex ORM and axios and brings a unified process to perform requests and persist response data with ease.

// Example usage: fetch users and persist to store.
User.api().get('/api/users')

Sponsors

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

Super Love Sponsors

Peter Tóth Mario Kolli Cannikan Andy Koch Dylan Copeland

Big Love Sponsors

geraldbiggs Cue Kazuya Kawaguchi jShaf

A Love Sponsors

George Chaduneli bpuig John mean-cj

Documentation

You can check out the full documentation for Vuex ORM Plugin: Axios at https://vuex-orm.github.io/plugin-axios.

Questions & Discussions

Join us on our Slack Channel for any questions and discussions.

Although there is the Slack Channel, do not hesitate to open an issue 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.

Plugins

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

Contribution

We are excited that you are interested in contributing to Vuex ORM Plugin: Axios! 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.

yarn build

Compile files and generate bundles in dist directory.

yarn lint

Lint files using Prettier.

yarn test

Run the test using Jest.

yarn test:watch

Run the test in watch mode.

yarn coverage

Generate test coverage in coverage directory.

yarn docs

Build and boot documentation server with VuePress.

License

Vuex ORM Plugin: Axios is open-sourced software licensed under the MIT license.