oxboot/oxboot

WordPress boilerplate with modern development tools, easier configuration, and an improved folder structure

v1.0.6 2019-03-22 11:05 UTC

Requires

• php: >=7.1
• composer/installers: ^1.4
• illuminate/support: 5.6.*
• jjgrainger/posttypes: ^2.0
• mcaskill/composer-exclude-files: ^1.1
• mnsami/composer-custom-directory-installer: ^1.1
• oomphinc/composer-installers-extender: ^1.1
• oscarotero/env: ^1.1.0
• oxboot/controller: v1.0.0-alpha4
• roots/sage-lib: ~9.0.7
• roots/sage-woocommerce: ^1.0
• roots/wordpress: 5.1
• roots/wp-config: 1.0.0
• roots/wp-password-bcrypt: 1.0.0
• stoutlogic/acf-builder: ^1.8
• vlucas/phpdotenv: ^2.0.1
• wikimedia/composer-merge-plugin: ^1.4

Requires (Dev)

• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^3.0.2

MIT

• Scott Walkinshaw
• Ben Word
• Zorca Orcinus

• composer
• wordpress
• wp
• roots
• bedrock
• wp-config
• oxboot

README

Oxboot is a modern WordPress stack that helps you get started with the best development tools and project structure.

Much of the philosophy behind Bedrock is inspired by the Twelve-Factor App methodology including the WordPress specific version.

Features

• Better folder structure
• Dependency management with Composer
• Easy WordPress configuration with environment specific files
• Environment variables with Dotenv
• Autoloader for mu-plugins (use regular plugins as mu-plugins)
• Enhanced security (separated web root and secure passwords with wp-password-bcrypt)

Requirements

• PHP >= 7.1
• Composer - Install

Installation

1. Create a new project:

   $ composer create-project roots/bedrock

2. Update environment variables in the .env file:

• DB_NAME - Database name
• DB_USER - Database user
• DB_PASSWORD - Database password
• DB_HOST - Database host
• WP_ENV - Set to environment (development, staging, production)
• WP_HOME - Full URL to WordPress home (https://example.com)
• WP_SITEURL - Full URL to WordPress including subdirectory (https://example.com/wp)
• AUTH_KEY, SECURE_AUTH_KEY, LOGGED_IN_KEY, NONCE_KEY, AUTH_SALT, SECURE_AUTH_SALT, LOGGED_IN_SALT, NONCE_SALT
  • Generate with wp-cli-dotenv-command
  • Generate with our WordPress salts generator

1. Add theme(s) in web/app/themes/ as you would for a normal WordPress site
2. Set the document root on your webserver to Bedrock's web folder: /path/to/site/web/
3. Access WordPress admin at https://example.com/wp/wp-admin/

Documentation

Bedrock documentation is available at https://roots.io/bedrock/docs/.

Contributing

Contributions are welcome from everyone. We have contributing guidelines to help you get started.

Bedrock sponsors

Help support our open-source development efforts by becoming a patron.

Community

Keep track of development and community news.

• Participate on the Roots Discourse
• Follow @rootswp on Twitter
• Read and subscribe to the Roots Blog
• Subscribe to the Roots Newsletter
• Listen to the Roots Radio podcast