dev-develop
dev-developA modern WordPress boilerplate for building organized and standardized themes
MIT
The Requires
- php >=5.2.4
The Development Requires
wordpress boilerplate theme tonik wordpress-theme wordpress-starter-theme
Wallogit.com
2017 © Pedro Peláez
wordpress-theme wordpress-theme-boilerplate
A modern WordPress boilerplate for building organized and standardized themes
tonik/wordpress-theme-boilerplate
A modern WordPress boilerplate for building organized and standardized themes
- Wednesday, April 25, 2018
- by GrzegorzRybkowski
- Repository
- 4 Watchers
- 6 Stars
- 0 Installations
- PHP
- 0 Dependents
- 0 Suggesters
- 0 Forks
- 0 Open issues
- 3 Versions
- 0 % Grown
The README.md
Tonik — Wordpress Theme Boilerplate
The
developbranch tracks boilerplate development and it's not a stable code. If you want a stable version, use themasterbranch or one of the latest releases., (*1)
Boilerplate aims to be compatible with a large range of PHP versions, however, still have modern tooling for developing a theme.
What's inside?, (*2)
- Gulp - Task runner
- SASS - a CSS preprocessor
- Babel - JavaScript ES6 to ES5 compiler
- Rollup - a JavaScript Modules Bundler
- Stylelint - a SCSS linter
- ESLint - a JavaScript linter
- PHP_CodeSniffer - a PHP sniffer
The front-end builder was borrowed from our html-frontend-boilerplate project., (*3)
Requirements
Boilerplate follows a WordPress minimal requirements. Make sure you have these dependences installed before moving on: - PHP >= 5.2.4, (*4)
Theme uses NPM as a front-end dependency manager. Make sure your development machine has installed following dependencies: - Node.js - NPM, (*5)
Installation
WordPress themes lives in the wp-content/themes folder. This is where we have to fetch our fresh starter files., (*6)
# Go to the `themes` directory of your WordPress installation. $ cd wp-content/themes
Create project via composer create-project composer command., (*7)
$ composer create-project tonik/wordpress-theme-boilerplate <theme-name>
You can also directly download or clone the repository to the wp-content/themes directory., (*8)
# Clone repository to the <theme-name> folder. $ git clone -b master git@github.com:tonik/wordpress-theme-boilerplate.git <theme-name>
Development
A Gulp task runner is used to compile and optimize theme's scripts, stylesheets, and images., (*9)
Resolving front-end dependencies
Before being able to build theme you have to resolve required dependencies., (*10)
# @ wp-content/themes/<theme-name> # Install node dependencies. $ npm install
Now you have all the packages necessary to run the build process and start developing your theme., (*11)
Building a Theme
There are a few available commands which help you to build the theme for different environments:, (*12)
# @ wp-content/themes/<theme-name> # Compiles unminified and unoptimized theme assets with source maps. $ npm run development # Alias for `development` command. $ npm run dev # Compiles minified and optimized theme assets without source maps. $ npm run production # Alias for `production` command. $ npm run prod # Builds assets for development, runs watcher (recompiles on change) # and BroswerSync (refreshes browser). $ npm run watch
Contributing
Great that you are considering supporting the project. You have a lot of ways to help us grow. We appreciate all contributions, even the smallest., (*13)
- Report an issue
- Propose a feature
- Send a pull request
- Star project on the GitHub
- Tell about project around your community
License
The Tonik WordPress Theme Boilerplate is licensed under the MIT license., (*14)