Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vuex-orm/plugin-axios
Vuex ORM persistence plugin to sync the store against a RESTful API.
https://github.com/vuex-orm/plugin-axios
axios vue vuex vuex-orm vuex-orm-plugin vuex-plugin
Last synced: 20 days ago
JSON representation
Vuex ORM persistence plugin to sync the store against a RESTful API.
- Host: GitHub
- URL: https://github.com/vuex-orm/plugin-axios
- Owner: vuex-orm
- License: mit
- Created: 2018-10-02T06:58:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T10:10:21.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T13:04:24.397Z (7 months ago)
- Topics: axios, vue, vuex, vuex-orm, vuex-orm-plugin, vuex-plugin
- Language: TypeScript
- Homepage: https://vuex-orm.github.io/plugin-axios/
- Size: 3.94 MB
- Stars: 361
- Watchers: 17
- Forks: 53
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Vuex ORM Plugin: Axios
Vuex ORM Axios plugin adds smooth integration between API requests and [Vuex ORM](https://github.com/vuex-orm/vuex-orm) data persistence through the awesome [axios](https://github.com/axios/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.
```js
// 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 :two_hearts:
Super Love Sponsors
Big Love Sponsors
A Love Sponsors
## 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](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/plugin-axios/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.
## Plugins
Vuex ORM can be extended via plugins to add additional features. Here is a list of available plugins.
- [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.
## 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.
```bash
yarn build
```
Compile files and generate bundles in `dist` directory.
```bash
yarn lint
```
Lint files using [Prettier](https://prettier.io/).
```bash
yarn test
```
Run the test using [Jest](https://jestjs.io/).
```bash
yarn test:watch
```
Run the test in watch mode.
```bash
yarn coverage
```
Generate test coverage in `coverage` directory.
```bash
yarn docs
```
Build and boot documentation server with [VuePress](https://vuepress.vuejs.org/).
## License
Vuex ORM Plugin: Axios is open-sourced software licensed under the [MIT license](./LICENSE).