No description or website provided.
CSS PHP JavaScript
Latest commit c57590f Jan 23, 2017 @jedrzejchalubek jedrzejchalubek committed on GitHub Merge pull request #6 from tonik/1.2.0
Move to use new CLI package

README.md

Introduction

Requirements

Make sure you have all these dependences installed before moving on:

Installation

Creating new Theme

Create project via composer create-project composer command.

$ composer create-project tonik/theme <theme-name>

You can also directly download or clone repository to the wp-content/themes directory.

# Clone repository to the <theme-name> folder.
$ git clone git@github.com:tonik/theme.git <theme-name>

Resolving Dependences

Install backend dependeces and generate autoloading file.

# Install composer dependences.
$ composer install

Install frontend dependences and task runner.

# Install node dependences.
$ npm install

Development

Compiling Assets

Theme uses Laravel Elixir to compile it's scripts and stylesheets. Files are generated to the public directory.

# Run compile tasks.
$ gulp

# Watch for file changes and rund compile tasks.
$ gulp watch

# Compile assets for production.
$ gulp --production

Folders and Files Structure

This starter theme introduces "easy to follow" folder structure, which enforce to divide your theme logic into components.

theme
    ├── bootstrap/
    ├── config/
    │   ├── theme.php
    ├── public/
    │   ├── js
    │   ├── css
    │   ├── images
    │   ├── fonts
    ├── resources/
    │   ├── assets
    │   │   ├── js
    │   │   ├── sass
    │   ├── templates
    ├── src/
    │   ├── Http/
    │   │   ├── ajaxes.php
    │   │   ├── assets.php
    │   ├── Setup/
    │   │   ├── actions.php
    │   │   ├── filters.php
    │   │   ├── navs.php
    │   │   ├── shortcodes.php
    │   │   ├── sidebars.php
    │   │   ├── supports.php
    │   │   ├── widgets.php
    │   ├── Structure/
    │   │   ├── posttypes.php
    │   │   ├── taxonomies.php
    │   ├── helpers.php
    ├── 404.php
    ├── composer.json
    ├── footer.php
    ├── functions.php
    ├── gin
    ├── header.php
    ├── index.php
    ├── package.json
    ├── screenshot.png
    ├── style.css

USAGE.md Boilerplate

USAGE.md provides "How to use" guide for themes created with this starter. Remember to properly fill this file before finalising project. Your clients will be grateful.