Slush generator for StoreFront projects
npm install slush-storefront
> Slush generator for Searchandiser UI projects
Install slush globally:
``bash`
$ npm install -g slush
Install slush-storefront globally:
`bash`
$ npm install -g slush-storefront
This generator may be used to create any of the following StoreFront artifacts:
| Type | Command | Supports Prompts | Supports CLI |
| :------ | :----------------------------| :--------------- | :----------- |
| project | slush storefront | Y | N |slush storefront:component
| component | | Y | Y |
Create a new folder for your project:
`bash`
$ mkdir my-storefront
Run the generator from within the new folder:
`bash`
$ cd my-storefront && slush storefront
#### via Prompts
To generate a component by answering a series of questions, execute the following:
`
slush storefront:component
#### via CLI
To generate a component directly from the command line, execute the following:
`
slush storefront:component
When generating the component's definition and test files, the path argument is implicitly relative to the project's source code and test code directories (by default, these are assumed to be src/ and test/unit). The following flags may be used to override these defaults:
`Include the --srcRoot flag to overwrite the default source code directory.
slush storefront:component
`Include the --testRoot flag to overwrite the default test directory.
slush storefront:component
Please note that using non-default values for the source or test directories will require an update to the project's Webpack configuration file.
Slush is a tool that uses Gulp for project scaffolding.
Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.
To find out more about Slush, check out the documentation.