You need to make sure you have at least the followings to use the theme:
- PHP 5.6
- composer
You need to make sure you have installed composer globally in your terminal just by running
composer -v you should have an output as follows:
$ composer -v
______
/ ____/___ ____ ___ ____ ____ ________ _____
/ / / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
/ /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ /
\____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
/_/
Composer version 1.2.1 2016-09-12 11:27:19
- Download or clone the theme
- Go to the theme path and run
composer install
The theme uses composer as dependency manager for PHP
libraries and script mananger for the theme, inside of the theme you have the following commands
available.
To run any of the following commands you only need to type the name of the command on your terminal for instance:
composer lint
This task run:
composer build-depscomposer buld-app
Install all the required packages from package.json inside of the patterns
directory, this command is executed automatically after you run composer install or composer update
This task generates the production ready assets by running gulp build
inside of the patterns directory.
Function that executes the linter task for the .php files except on vendor directory the files
are specified as follows:
*.php src/*.php **/*.php src/**/**/*.php --ignore=vendor
If you want to change this just edit composer.json file to adjust based on your needs.
The linter for PHP uses the WordPresss Coding Standard
configuration to make sure we follow the coding standards specified by the WordPress handbook.
Script that is executed automatically after composer install or composer update and is used to
setup the linter configuration for PHP.
Script to create a organism/molecule/atom folder inside of the patterns directory, as well as php/scss files. It will also add the corresponding calls to the scss file in the general _style.scss file. To run this task:
composer organism -- <name-of-element>composer molecule -- <name-of-element>composer atom -- <name-of-element>
List of
hooksandfiltersavailables to be used with this theme.
Action executed before the main <header> tag and after the <body> tag, useful
if you want to add something before anyother tag on the site.
Action executed after the main </header> tag. Useful if you want to add something
just after the header has been rendered.
Action that is executed before the main <footer> tag. Useful to add something
before the last tag of the page is added.
Action that is executed before the closing </body> tag and just after the
</footer> tg. Useful to add something at the end of the site.
The following is a collection of filters available to be used to change settings and options from the theme at any point.
With this filter you can change the location of the ACF files, by default saves
the ACF Groups into the acf directory located on the theme.
By default is set to true, with this filter you can remove the automatic
save of ACF Fields into the lean/acf_path.
This function renders a new icon from the sprite set.
Parameters
- id: the file name of the icon for example if you have a file
patterns/static/icons/facebook.svgtheidof the icon isfacebook. - class_name: The
class_nameattribute is an optional parameter that can be used to add a custom class to the specifc instance of the icon if a different style is required.