A Modern WordPress Starter Theme for savvy Developers
Clone or download
Permalink
Failed to load latest commit information.
acf-json PHPCS fixes for WordPress coding standards May 6, 2017
assets PHPCS and ESLint Travis build (#26) Aug 16, 2018
inc Fixed typos Aug 12, 2018
page-templates Fixed small typi Jun 4, 2017
views Modernize Travis (#25) Aug 16, 2018
.env.example Updated gulp and browser-sync to properly handle https localhosts Dec 16, 2017
.eslintignore PHPCS and ESLint Travis build (#26) Aug 16, 2018
.eslintrc.json PHPCS and ESLint Travis build (#26) Aug 16, 2018
.gitignore trevis improvements Aug 16, 2018
.phpcs.xml.dist trevis improvements Aug 16, 2018
.travis.yml Removed unused dependencies from travis Aug 31, 2018
404.php PHPCS and ESLint Travis build (#26) Aug 16, 2018
LICENSE.txt Updated readme file, license, and some hinting May 2, 2017
README.md Updated readme file Apr 2, 2018
archive.php Modernize Travis (#25) Aug 16, 2018
comments.php Modernize Travis (#25) Aug 16, 2018
composer.json Modernize Travis (#25) Aug 16, 2018
footer.php Fix translators (#28) Aug 28, 2018
functions.php Update functions.php (#30) Sep 6, 2018
header.php Modernize Travis (#25) Aug 16, 2018
index.php Modernize Travis (#25) Aug 16, 2018
package.json PHPCS and ESLint Travis build (#26) Aug 16, 2018
page.php Modernize Travis (#25) Aug 16, 2018
rtl.css add: support for RTL Dec 4, 2016
ruleset.xml PHPCS and ESLint Travis build (#26) Aug 16, 2018
screenshot.png Updated views folder structure May 8, 2017
search.php missing < in PHP open tag (#29) Aug 31, 2018
sidebar.php Modernize Travis (#25) Aug 16, 2018
single.php Modernize Travis (#25) Aug 16, 2018
style.css Updated style version Mar 30, 2018
webpack.mix.js Modernize Travis (#25) Aug 16, 2018
wp-config.sample.php PHPCS fixes for WordPress coding standards May 6, 2017

README.md

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