Zao Starter Theme

Dependencies

1. Node & NPM - Build packages and 3rd party dependencies are managed through NPM, so you will need that installed globally
2. Gulp - Gulp is used as the main task runner, it runs PostCSS, processes images, handles SVG sprites (if needed), and executes Webpack
3. Webpack - Webpack is used to process the JavaScript
4. Composer - Composer is used to manage PHP.

Getting Started

Direct Install

• Clone the repository

• Rename folder theme-scaffold -> your project's name

• Do case-sensitive search/replace for the following:

  • ZaoStarterTheme
  • ZAO_STARTERTHEME
  • zao-starter-theme
  • ZAO_STARTERTHEME
  • Zao Starter Theme

• cd into the theme folder

• run npm run start

NPM Commands

npm run start (install dependencies and run initial gulp)

npm run watch (watch)

npm run build (build all files)

npm run deploy (build all files for deploy)

Composer Commands

composer lint (lint PHP files)

composer lint-fix (lint PHP files and automatically correct coding standard violations)

Contributing

We don't know everything! We welcome pull requests and spirited, but respectful, debates. Please contribute via pull requests on GitHub.

1. Fork it!
2. Create your feature branch: git checkout -b feature/my-new-feature
3. Commit your changes: git commit -am 'Added some great feature!'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request

Learn more about the default packages used with this project

• Babel core
• Babel eslint
• Babel loader
• Babel preset env
• Can I Use DB
• Del
• Eslint
• Eslint loader
• Gulp
• Gulp CSSNano
• Gulp filter
• Gulp Live Reload
• Gulp PostCSS
• Gulp Rename
• Gulp Sourcemaps
• PostCSS CSSNext
• PostCSS Import
• Pump
• Require DIR
• Run Sequence
• Webpack
• Webpack CLI
• Webpack Stream
• Husky@next
• Lint Staged
• PHPCS