Demoshop Guide

Last updated:
Edit on GitHub

Bootstrap the project

To install all frontend the external dependecies for Yves and Zed, run in the VM console: cd /path/to/project/root ./setup -i

Yves

To build assets for Yves, run in the console:

cd /path/to/project/root
npm run yves # build assets in development mode
npm run yves:watch # build assets in development mode with watchers over the code
npm run yves:production # build assets in production mode
npm run yves:stylelint # helps you avoid errors and enforce conventions in your SCSS
npm run yves:tslint # helps you avoid errors and enforce conventions in your Typescript
Inside and outside the VM
You can run these scripts inside and outside the VM. Run them outside the VM if you want to improve the build performance and the watchers speed. To use NPM commands outside the VM, you need to download and install [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Minimum versions for node is 8.x and for npm - 5.x. Maximum version for Node.js is the one [Recommended for Most Users](https://nodejs.org/en/).

Zed

To build assets for Zed, run in the console:

cd /path/to/project/root
npm run zed # build assets in development mode
npm run zed:watch # build assets in development mode with watchers over the code
npm run zed:production # build assets in production mode
Inside and outside the VM
You can run these scripts inside and outside the VM. Run them outside the VM if you want to improve the build performance and the watchers speed. To use NPM commands outside of the VM, you need to download and install [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Minimum versions for Node.js is 8.x and for npm - 5.x. Maximum version for Node.js is the one [Recommended for Most Users](https://nodejs.org/en/).

Custom scripts

If you need to add or change the scripts, open the @project/package.json manifest file and change the related section:

"scripts": {
	"yves": "node ./frontend/build development",
	"yves:watch": "node ./frontend/build development-watch",
	"yves:production": "node ./frontend/build production",
	"yves:help": "node ./frontend/libs/command-line-parser --help",
	"yves:stylelint": "NODE_ENV=development node ./frontend/libs/stylelint development",
	"yves:tslint": "node ./frontend/libs/tslint",
	"zed": "node ./node_modules/@spryker/oryx-for-zed/build",
	"zed:watch": "node ./node_modules/@spryker/oryx-for-zed/build --dev",
	"zed:production": "node ./node_modules/@spryker/oryx-for-zed/build --prod"
}