feryardiant / wpdev
WordPress boilerplate based-on Bedrock by Roots.
Fund package maintenance!
feryardiant
Ko Fi
Open Collective
paypal.me/feryardiant
Installs: 8
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 5
Forks: 5
Open Issues: 2
Type:project
Requires
- php: >=7.1
- ext-exif: *
- ext-gd: *
- ext-imagick: *
- ext-redis: *
- composer/installers: ^1.8
- humanmade/s3-uploads: ^2.1
- oscarotero/env: ^1.2
- rhubarbgroup/redis-cache: ^1.6
- roots/bedrock-autoloader: ^1.0
- roots/wordpress: ^5.4
- roots/wp-config: ^1.0
- roots/wp-password-bcrypt: ^1.0
- vlucas/phpdotenv: ^4.1
- wpackagist-plugin/contact-form-7: ^5.1
- wpackagist-plugin/regenerate-thumbnails: ^3.1
- wpackagist-plugin/wordpress-importer: ^0.7
- wpdev/blank-child: *
Requires (Dev)
- 10up/wp_mock: ^0.4.2
- aaemnnosttv/wp-cli-dotenv-command: ^2.0
- dealerdirect/phpcodesniffer-composer-installer: ^0.6
- phpcompatibility/phpcompatibility-wp: ^2.1
- phpunit/phpunit: ^7.5
- roave/security-advisories: dev-master
- squizlabs/php_codesniffer: ^3.4
- wp-cli/core-command: ^2.0
- wp-cli/import-command: ^2.0
- wp-coding-standards/wpcs: ^2.1
- wpackagist-plugin/query-monitor: ^3.5
- wpackagist-plugin/theme-check: 20190801.1
Suggests
- ext-bcmath: *
- ext-gettext: *
- ext-mbstring: *
This package is auto-updated.
Last update: 2024-11-11 12:27:51 UTC
README
This project aims to provide complete solution for WordPress development and deployment to heroku, even though it isn't completed just yet. 😬
Inspired by wordpress-heroku by Phillip Heuer and based on the exact same boilerplate of Bedrock, this project will give you better experiences while developing your very own WordPress themes and plugins that easily deployed to heroku.
Features
- Integrated Unit and end-to-end testing
- Custom heroku buildpack
- Automated changelog generator
- Better assets compilation
- Easily create archive that ready to distribute to WordPress themes or plugins directory
- Thoughts? let me know 😁
Requirements
Its always good to have WP-CLI installed globally on your system. For Database and HTTP Server requirements please refer to this documentation.
Installation
1. One-Click-Deployment
Using this button you can deploy a new instance of WordPress. All required extensions will be deployed automatically. This also works if you fork your own project to work on your site.
2. Using composer create-project
command
$ composer create-project feryardiant/wpdev [project-folder]
Create new database through PHPMyAdmin or from CLI
$ mysql -u[username] -p -e 'create database <database-name>'
Configure your .env
file to suit your local setup, described here, also don't forget to set the url
key on wp-cli.local.yml
file as well. Once you're done, let's install WordPress core with the following command:
# Please consult to the official documentation for additional option you might needed for the setup # See: https://developer.wordpress.org/cli/commands/core/install/ $ vendor/bin/wp core install # Or you can simply run the following sortcut $ composer wp:install
Please make sure to configure your HTTP server' document root
to public
directory.
Development
I using gulp
for almost all development workflow in this project, not only for compiling scss
files, minify images and compressing js
, but also to run development server. Once you're done with installation process above, please install the development dependencies through yarn
$ yarn
To start the development server you can simply run command below:
# yarn global add glup-cli or npm -g install gulp-cli, in case you don't have one
$ gulp
The gulp default task will fire up PHP Developent Server, start BrowserSync on port 3000
and watch the changes you made. That way, all you need to do is open your web browser and type http://localhost:3000
on the address bar, open the project on your favorite code editor or IDE and start working.
All the changes you've made will be automatically linted and compiled, once it done BrowserSync will reload the browser for you.
Workflow
Since this project is based on Bedrock, the project directory structure is pretty much similar, but with some tweaks.
Directory Structure and Gulp tasks
- bin directory : Consists of all buildpack executables only, feel free to delete this directory once you've cloned this project or install it on your local machine,
- config directory : Consists of all build utilities and configuration files, including all the scripts you'd be using on all environment,
- public directory : The server document root directory,
- packages directory : The Themes and Plugins development directory of your project,
- tests directory : Testing directory, obviously.
├── bin
├── config
│ ├── environments
│ └── heroku
├── public
│ ├── app
│ └── wp
├── packages
├── resources
└── tests
├── e2e
├── stubs
└── unit
The gulp
scripts will autoatically scan any sub-directories under plugins
and themes
and generate all the required gulp
tasks if the sub-directory meets the following structures:
<dirname>
├── assets
│ ├── img
│ ├── js
│ └── scss
└── languages
Once you've create <dirname>
above inside plugins
or themes
directory, you'll see similar gulp tasks as following:
$ gulp -T
├── theme-plugin:php
├── theme-plugin:zip
├─┬ theme-plugin:build
│ └─┬ <parallel>
│ └── theme-plugin:php
├── theme:php
├── theme:img
├── theme:css
├── theme:js
├── theme:zip
├─┬ theme:build
│ └─┬ <parallel>
│ ├── theme:css
│ ├── theme:img
│ ├── theme:js
│ └── theme:php
├── theme-child:php
├── theme-child:zip
├─┬ theme-child:build
│ └─┬ <parallel>
│ └── theme-child:php
├─┬ zip
│ └─┬ <series>
│ ├── theme-plugin:zip
│ ├── theme:zip
│ └── theme-child:zip
├─┬ build
│ └─┬ <parallel>
│ ├── theme-child:php
│ ├── theme-plugin:php
│ ├── theme:css
│ ├── theme:img
│ ├── theme:js
│ └── theme:php
├── e2e
├── release
└── default
Notes
<dirname>:build
task will execute all task under<dirname>
namespace, except for<dirname>:zip
task.- Each
*:css
,*:img
and*:js
will only available if you haveimg
,js
andscss
directories underassets
directory. build
task will combine all*:build
tasks on each namespace.zip
task will combine all*:zip
tasks on each namespace.release
task will runbuild
task, generateCHANGELOG.md
, runzip
task and bump version number of this project.
Sponsors
Credits
- WordPress - GPLv2 License
- Bedrock - MIT License
- Underscores - GPLv2 License
- Bulma - MIT License
- Gulp and its plugins
- BrowserSync
License
(c) 2019 Fery Wardiyanto - MIT license.