Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.2 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.2 KB
Raw

awps

A Modern WordPress Starter Theme for savvy Developers

Build Status Dependecies NPM latest GPL License Code Climate

Prerequisites

This theme relies on NPM and Composer in order to load dependencies and packages. Webpack should always be running and watching during the development process, in order to properly compile and update files.

Installation

  • Move the .env.example to your WordPress root directory, rename it as .env, and setup your website variables
  • Move the wp-config.sample.php to your WordPress root directory and rename it as wp-config.php, to replace the default one
  • Open a Terminal window on the location of the theme folder
  • Execute composer install
  • Execute npm install

Webpack

AWPS uses Laravel Mix for assets management. Check the official documentation for advanced options

  • Edit the webpack.mix.js in the root directory of your theme to set your localhost URL and customize your assets
  • npm run watch to start browserSync with LiveReload and proxy to your custom URL
  • npm run dev to quickly compile and bundle all the assets without watching
  • npm run prod to compile the assets for production

Features

  • Bult-in webpack.mix.js for fast development and compiling.
  • OOP PHP, and namespaces with PSR4 autoload.
  • Customizer ready with boilerplate and example classes.
  • Gutenberg ready with boilerplate and example blocks.
  • ES6 Javascript syntax ready.
  • Compatible with JetPack, WooCommerce, ACF PRO, and all the most famous plugins.
  • Built-in FlexBox Responsive Grid.
  • Modular, Components based file structure.

License

GPLv3