boxuk / wp-project-skeleton
A skeleton WordPress project to be used as a base for new WordPress projects.
Installs: 120
Dependents: 0
Suggesters: 0
Security: 0
Stars: 50
Watchers: 13
Forks: 4
Open Issues: 3
Type:project
Requires
- boxuk/wp-hook-attributes: ^0.0.2
- boxuk/wp-muplugin-loader: ^2.0
- cache/memcache-adapter: ^1.2
- inpsyde/wonolog: ^1.0
- inpsyde/wp-translation-downloader: ^2.0
- jamesrwilliams/flagpole: @beta
- oomphinc/composer-installers-extender: ^2
- roots/wordpress-core-installer: ^1.100
- roots/wordpress-full: ^6.0
- symfony/config: ^5.0 || ^6.0
- symfony/dependency-injection: ^5.0 || ^6.0
- symfony/dotenv: ^5.0 || ^6.0
- symfony/yaml: ^5.0 || ^6.0
- wp-cli/scaffold-command: ^2.0
- wp-cli/wp-cli: ^2.5
- wpackagist-plugin/advanced-caching: @dev
- wpackagist-plugin/memcached: ^4.0
- wpackagist-plugin/query-monitor: ^3.5
- wpackagist-plugin/surge: ^1.0
Requires (Dev)
- phpunit/phpunit: ^7 || ^8 || ^9
- wp-phpunit/wp-phpunit: ^6.0
- yoast/phpunit-polyfills: ^1.0
Suggests
- timber/timber: Needed for the i18n-twig WP CLI command.
- twig/extensions: Needed for the i18n-twig WP CLI command.
- twig/twig: Needed for the i18n-twig WP CLI command.
- wp-cli/i18n-command: Needed for the i18n-twig WP CLI command.
Replaces
- boxuk/boxuk-base-wp-plugin: 0.4.0
This package is auto-updated.
Last update: 2024-11-06 16:47:29 UTC
README
BoxUK WordPress Project Skeleton
A base WordPress project from Box UK to get you up and running quickly.
Installation
Create a new project with composer
composer create-project boxuk/wp-project-skeleton my-project --stability=dev
Install with the simple install script
bin/install my-project
Note: This is an interactive command.
Usage
Frontend:
You will be faced with a security warning.
On Chrome, type
thisisunsafe
to bypass. On other browsers follow the prompts.To find out more about this and what options you have, read the dedicated section on HTTPS.
Admin:
https://my-project.local/wp-admin
Username is:
admin
An admin password would have been generated during install, but unless you were beady eyed you probably missed it. You can easily regenerate an admin password using the following command:
bin/docker/wp user update admin --user_pass=your_password_here
Features
🐳 - Fully dockerized setup
📦 - Composer based plugin management
📧 - Email testing with mailhog
🚀 - Memcached support
🔥 - Blackfire support
🧐 - Monorepo support
📋 - Dictator support for dictating state across environments
🪜 - Fixtures support using wp-cli-fixtures
💉 - Baked in Dependency Injection support with Symfony
🪝 - DI based hook solution using tags
🏋️♀️ - Optimised mu-plugin setup, including scaffold tool
🚩 - First class support for feature flags using flagpole
✅ - Unit, Integration and Visual Regression testing support
💻 - Logging support through Wonolog
You can read more about all of these features in this post on the Box UK blog.
Documentation
- Getting Started
- Usage
- Keeping up to date
- Troubleshooting
- Premium plugins
- Patched plugins
- VIP project?
- Monorepo
- Custom code
- Working with a styleguide
- i18n
- Tools
- Testing
- Logging