{"id":13468791,"url":"https://github.com/vue-electron/vuex-electron","last_synced_at":"2025-03-26T05:31:19.524Z","repository":{"id":32959260,"uuid":"147774012","full_name":"vue-electron/vuex-electron","owner":"vue-electron","description":"Integration of Vuex and Electron","archived":false,"fork":false,"pushed_at":"2024-05-19T15:21:18.000Z","size":454,"stargazers_count":304,"open_issues_count":56,"forks_count":95,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-12T17:04:22.136Z","etag":null,"topics":["electron","javascript","vue","vuex"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vue-electron.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-07T05:17:51.000Z","updated_at":"2025-02-28T03:02:29.000Z","dependencies_parsed_at":"2024-06-18T13:59:03.655Z","dependency_job_id":"8718e5a9-4c9d-4caf-aa10-03dc859fecb8","html_url":"https://github.com/vue-electron/vuex-electron","commit_stats":{"total_commits":33,"total_committers":5,"mean_commits":6.6,"dds":"0.18181818181818177","last_synced_commit":"c256f0063b8ce99f4594b7990805cb4eb33a7127"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vue-electron%2Fvuex-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vue-electron%2Fvuex-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vue-electron%2Fvuex-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vue-electron%2Fvuex-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vue-electron","download_url":"https://codeload.github.com/vue-electron/vuex-electron/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245090875,"owners_count":20559298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","javascript","vue","vuex"],"created_at":"2024-07-31T15:01:19.178Z","updated_at":"2025-03-26T05:31:18.950Z","avatar_url":"https://github.com/vue-electron.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"750\" src=\"https://user-images.githubusercontent.com/678665/45566726-404d9e80-b860-11e8-94b6-527dfcc3b3b3.png\"\u003e\n\u003c/p\u003e\n\n# Vuex Electron\n\n[![Travis](https://img.shields.io/travis/com/vue-electron/vuex-electron.svg?style=for-the-badge\u0026longCache=true)](https://travis-ci.com/vue-electron/vuex-electron)\n[![Code Climate](https://img.shields.io/codeclimate/maintainability/vue-electron/vuex-electron.svg?style=for-the-badge\u0026longCache=true)](https://codeclimate.com/github/vue-electron/vuex-electron)\n[![Code Climate](https://img.shields.io/codeclimate/coverage/vue-electron/vuex-electron.svg?style=for-the-badge\u0026longCache=true)](https://codeclimate.com/github/vue-electron/vuex-electron)\n[![Code Style Prettier](https://img.shields.io/badge/code%20style-prettier-brightgreen.svg?style=for-the-badge\u0026longCache=true)](https://github.com/prettier/prettier)\n[![Made With Love](https://img.shields.io/badge/made%20with-love-brightgreen.svg?style=for-the-badge\u0026longCache=true)](https://github.com/MrEmelianenko)\n\nThe easiest way to share your Vuex Store between all processes (including main).\n\n### Features\n\n:star: Persisted state  \n:star: Shared mutations\n\n### Requirements\n\n- [Vue](https://github.com/vuejs/vue) v2.0+\n- [Vuex](https://github.com/vuejs/vuex) v2.0+\n- [Electron](https://github.com/electron/electron) v2.0+\n\n### Installation\n\nInstallation of the Vuex Electron easy as 1-2-3.\n\n1. Install package with using of [yarn](https://github.com/yarnpkg/yarn) or [npm](https://github.com/npm/cli):\n\n    ```\n    yarn add vuex-electron\n    ```\n\n    or\n\n    ```\n    npm install vuex-electron\n    ```\n\n2. Include plugins in your Vuex store::\n\n    ```javascript\n    import Vue from \"vue\"\n    import Vuex from \"vuex\"\n\n    import { createPersistedState, createSharedMutations } from \"vuex-electron\"\n\n    Vue.use(Vuex)\n\n    export default new Vuex.Store({\n      // ...\n      plugins: [\n        createPersistedState(),\n        createSharedMutations()\n      ],\n      // ...\n    })\n    ```\n\n3. In case if you enabled `createSharedMutations()` plugin you need to create an instance of store in the main process. To do it just add this line into your main process (for example `src/main.js`):\n\n    ```javascript\n    import './path/to/your/store'\n    ```\n\n4. Well done you did it! The last step is to add the star to this repo :smile:\n\n**Usage example: [Vuex Electron Example](https://github.com/vue-electron/vuex-electron-example)**\n\n## IMPORTANT\n\nIn renderer process to call actions you need to use `dispatch` or `mapActions`. Don't use `commit` because actions fired via `commit` will not be shared between processes.\n\n### Options\n\nAvailable options for `createPersistedState()`\n\n```javascript\ncreatePersistedState({\n  whitelist: [\"whitelistedMutation\", \"anotherWhitelistedMutation\"],\n\n  // or\n\n  whitelist: (mutation) =\u003e {\n    return true\n  },\n\n  // or\n\n  blacklist: [\"ignoredMutation\", \"anotherIgnoredMutation\"],\n\n  // or\n\n  blacklist: (mutation) =\u003e {\n    return true\n  }\n})\n```\n\n### Author\n\nAndrew Emelianenko  \nIG: [@truemelianenko](https://www.instagram.com/truemelianenko)\n\n### License\n\n[MIT License](https://github.com/vue-electron/vuex-electron/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvue-electron%2Fvuex-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvue-electron%2Fvuex-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvue-electron%2Fvuex-electron/lists"}