https://github.com/alecaddd/awps

A Modern WordPress Starter Theme for savvy Developers
https://github.com/alecaddd/awps

composer es6 gulp hacktoberfest namespaces npm wordpress

Last synced: 24 days ago
JSON representation

A Modern WordPress Starter Theme for savvy Developers

• Host: GitHub
• URL: https://github.com/alecaddd/awps
• Owner: Alecaddd
• License: gpl-3.0
• Created: 2016-07-28T23:23:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T10:00:37.000Z (over 1 year ago)
• Last Synced: 2024-10-11T23:40:36.470Z (24 days ago)
• Topics: composer, es6, gulp, hacktoberfest, namespaces, npm, wordpress
• Language: PHP
• Homepage:
• Size: 3.15 MB
• Stars: 412
• Watchers: 42
• Forks: 109
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ![awps](http://www.alecaddd.com/wp-content/uploads/2017/05/awps-logo.png)

> A Modern WordPress Starter Theme for savvy Developers

[![Build Status](https://travis-ci.org/Alecaddd/awps.svg?branch=master)](https://travis-ci.org/Alecaddd/awps) ![Dependecies](https://david-dm.org/Alecaddd/awps.svg) ![NPM latest](https://img.shields.io/npm/v/npm.svg) ![GPL License](https://img.shields.io/badge/license-GPLv3-blue.svg) [![Code Climate](https://codeclimate.com/github/Alecaddd/awps/badges/gpa.svg)](https://codeclimate.com/github/Alecaddd/awps)

## 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.

* Install [Composer](https://getcomposer.org/)

* Install [Node](https://nodejs.org/)

## 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](https://laravel.com/docs/5.6/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](https://github.com/Alecaddd/awps/blob/master/LICENSE.txt)