silverback/wp-website

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

v2.4.4 2020-07-21 06:45 UTC

Requires

• php: >=7.2
• composer/installers: ^1.7
• google/cloud-error-reporting: ^0.14.5
• monolog/monolog: ^1.23
• oscarotero/env: ^1.2.0
• roots/wordpress: ^5.3.0
• roots/wp-config: ~1.0.0
• roots/wp-password-bcrypt: ~1.0.0
• silverback/wp-helpers: ^5.2.0
• silverbackstudio/wp-log: ^1.0
• vlucas/phpdotenv: ^3.4.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.6.2
• phpcompatibility/phpcompatibility-wp: *
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^3.4.2
• wp-coding-standards/wpcs: ^2.3

Suggests

• silverback/wp-bootstrap: Installs some common Wordpress plugins

MIT

• Brando Meniconi
• Scott Walkinshaw
• Ben Word

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

README

This bolerplate is based on Bedrock, a modern WordPress stack that helps you get started with the best development tools and project structure.

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 roots.io's wp-password-bcrypt)

Requirements

• PHP >= 7.2
• Composer - Install

Installation

1. Create a new project:

   $ composer create-project silverback/wp-website

2. Update environment variables in the .env file:

• 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://localhost)
• WP_SITEURL - Full URL to WordPress including /wp subdirectory (https://localhost/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 Roots.io WordPress salts generator

1. Add theme(s) via composer require
2. Set the document root on your webserver to app web folder: /path/to/site/web/
3. Access WordPress admin at https://localhost/wp/wp-admin/

Development Environment with Docker

This boliperplate contains a pre-configured Docker environment with dedicated WP and MySQL containers. You can find a Visual Studio Code development guide in the .devcontainer folder (recommended) or you can manually launch it via docker-compose.yaml file.

Google App Engine

This boilerlate is made to be deployed to Google App Engine. Please read the GAE_DEPLOY guide.

Bedrock

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