Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ndabAP/vuex-cli-scaffold
NOT MAINTAINED Scaffold vuex actions, mutations, getters and the state
https://github.com/ndabAP/vuex-cli-scaffold
cli scaffold vue vuex
Last synced: 29 days ago
JSON representation
NOT MAINTAINED Scaffold vuex actions, mutations, getters and the state
- Host: GitHub
- URL: https://github.com/ndabAP/vuex-cli-scaffold
- Owner: ndabAP
- License: mit
- Created: 2017-08-23T10:50:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T20:40:01.000Z (almost 4 years ago)
- Last Synced: 2024-05-13T10:04:30.638Z (about 1 month ago)
- Topics: cli, scaffold, vue, vuex
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/vuex-cli-scaffold
- Size: 110 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue. - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold ★12 - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
- awesome-vue - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Components & Libraries / Utilities)
- awesome-vuejs - vuex-cli-scaffold - Scaffold vuex actions, mutations, getters and the state. (Utilities / State Management)
README
# NOT MAINTAINED vuex-cli-scaffold
Generating module entities for your Vue.js store is repetitive and verbose. This packages lets you create one or
multiple entities at once including the state, mutations, actions, getters, the module itself and even the store. You
can also create nested entities.
**Warning**: At the moment, it does not work with Yarn.
## Features
- Multiple entities
- nested entities
- includes all Vuex elements
## Installation
```bash
$ npm install vuex-cli-scaffold --save-dev
```
## Usage
By default, this package assumes that you'll have your modules stored at `src/store/modules` and the store itself at
`src/store/index.js`. To change the modules directory, simply append `modules=path` where `path` starts from your
applications root directory.
### Create entity
To create an entity, simply type this into the console.
```bash
$ npm run vuex-cli-scaffold product
```
This will create all necessary module files at `src/store/modules` including the state, mutations, actions, getters and
the module.
### Create multiple entities
To create multiple entities, type this into the console.
```bash
$ npm run vuex-cli-scaffold product shop basket
```
### Nested entity
You can even create nested entities.
```bash
$ npm run vuex-cli-scaffold shop shop/products shop/products/product
```
**Important**: When you creating nested entities, you have to manually set the modules value in the parent modules. In
our case, you would need to set the modules for all entities, unless you're using `-new`, which is explained below.
### Initialize store
If you start from zero, you can create a store next to other entities.
```bash
$ npm run vuex-cli-scaffold shop shop/products shop/products/product -new
```
All root entities will be added to the store. In our case the only root entity is `shop`.
## Author
[Julian Claus](https://www.julian-claus.de) and contributors.
## License
MIT