NPM version

This project needs at least npm 3.x.x

List commmands

• $ npm run info to display a list of all npm script
• $ npm run start or $ npm start launch an Express + BrowserSync local server. If you want to open your browser when server is ready $ npm run start:open
• $ npm run build build, copy all your file and assets in relevant folders : all img go to /build/assets/img/ folder, CSS & JS files go to /build/assets/main.(js|css), and template file are copied, with folder hierarchie.
• $ npm run testto launch Style and JS linter
• npm run test:eslint perform a full linting of all JS files in /src/ and reporte error in console. Follow the Standard JS StyleGuide except for indent, who are of 4 spaces.
• npm run test:eslintfmt try to format you JS file againt rules defined in .eslintrc file, if can't prompt for error.
• npm run test:stylelint perform a recursive linting of CSS file, againt Stylelint Config Standard, with 4 indent rule.
• npm run test:stylelfmt try to format your stylesheet according to rules specified in .stylelintrc file.

Tools

• rimraf for a better/crossplatform rm -rf you can use it like that : $ npm run rimraf <path/to/fileOrFolder>
• ncp Asynchronous recursive file & directory copying. Basic usage $ npm run ncp <source> <dest>

Usage

All path configurations should be administrable in config/project.config.js file. You can change where are stored views or assets folder by this way, pass some config for PostCss, and so on.

homePage point to the template you want to render (not the layout, the template).

viewsPath are related to the folder of all views basicly /views

assetsPath where all commons files are stored (css, js, images, etc.)/

viewsPath and assetsPath are used by BrowserSync to know file who watch

aliases are used to reproduce {% extends "@STARTERPack/layout.html.twig" %}

cssNextConfig are used by PostCSS modules.

Twig Filter and functions mock

StarterPack use node-twig to render Twig templates. You can find mocks for Twig in the extensions folder.