jazzman/wp-boilerplate

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

3.0 2022-09-27 08:33 UTC

Requires

• php: ^7.4|^8.1
• jazzman/wp-mail: ^1.3
• jazzman/wp-performance: ^3.3
• oscarotero/env: ^2.1
• roots/bedrock-autoloader: ^1.0
• roots/bedrock-disallow-indexing: ^2.0
• roots/wordpress: ^6.0
• roots/wp-config: ^1.0
• roots/wp-password-bcrypt: ^1.1
• vlucas/phpdotenv: ^5.4

Requires (Dev)

• roave/security-advisories: @dev
• symfony/var-dumper: ^6.1

MIT

• Scott Walkinshaw
• Ben Word
• Vasyl Sokolyk

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

README

Bedrock 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. Wrap values that may contain non-alphanumeric characters with quotes, or they may be incorrectly parsed.

• Database variables
  • DB_NAME - Database name
  • DB_USER - Database user
  • DB_PASSWORD - Database password
  • DB_HOST - Database host
  • Optionally, you can define DATABASE_URL for using a DSN instead of using the variables above (e.g. mysql://user:password@127.0.0.1:3306/db_name)
• 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