anchour/bedrock

A modern WordPress stack

Wednesday, May 4, 2016
by mrobit
Repository
2 Watchers
1 Stars
71 Installations

PHP
0 Dependents
0 Suggesters
825 Forks
0 Open issues
43 Versions
1 % Grown

The README.md

Bedrock

Version: 1.4.3, _(*1)

Bedrock is a modern WordPress stack that helps you get started with the best development tools and project structure., _(*2)

This is a fork of Roots, modified to use with deploying sites via Laravel Forge., _(*3)

What's This For?

This package is intended for use with Laravel Forge. Forge allows you to provision servers that are primarily used with Laravel, but allow you to deploy really anything you want. It comes with:, _(*4)

Nginx
PHP 5.5
MySQL

and more, pre-installed., _(*5)

Quick Start

Run composer create-project anchour/bedrock <path> (see Installation/Usage for more details), _(*6)

Features

Dependency management with Composer
Better folder structure
Easy WordPress configuration with environment specific files
Environment variables with Dotenv

Requirements

Git
PHP >= 5.3.2 (for Composer)

Installation/Usage

See Documentation for more details on the steps below., _(*7)

Using `create-project`

Composer's create-project command will automatically install the Bedrock project to a directory and run composer install., _(*8)

The post-install-cmd and post-root-package-install scripts will automatically create .env and prompt you about generating salt keys., _(*9)

Note: To generate salts without a prompt, run create-project with -n (non-interactive). You can also change the generate-salts setting in composer.json under config in your own fork. The default is true., _(*10)

To skip the scripts completely, create-project can be run with --no-scripts to disable it., _(*11)

Run composer create-project anchour/bedrock <path> (path being the folder to install to)
Add theme(s)
Access WP Admin at http://example.com/wp/wp-admin
Set your Nginx or Apache vhost to /path/to/site/public/.

Manually

Clone/Fork repo
Run composer install
Add theme(s)
Access WP Admin at http://example.com/wp/wp-admin
Set your Nginx or Apache vhost to /path/to/site/public/.

Documentation

Folder Structure

├── composer.json
├── config
│   ├── environments
│   │   ├── development.php
│   │   ├── staging.php
│   │   └── production.php
│   └── application.php
├── Gemfile
├── vendor
└── web
    ├── app
    │   ├── mu-plugins
    │   ├── plugins
    │   └── themes
    ├── wp-config.php
    ├── index.php
    └── wp

The organization of Bedrock is similar to putting WordPress in its own subdirectory but with some improvements., _(*12)

In order not to expose sensitive files in the webroot, Bedrock moves what's required into a public/ directory including the vendor'd wp/ source, and the wp-content source.
wp-content (or maybe just content) has been named app to better reflect its contents. It contains application code and not just "static content".
wp-config.php remains in the public/ because it's required by WP, but it only acts as a loader. The actual configuration files have been moved to config/ for better separation.
vendor/ is where the Composer managed dependencies are installed to.
wp/ is where the WordPress core lives. It's also managed by Composer but can't be put under vendor due to WP limitations.

Configuration Files

The root public/wp-config.php is required by WordPress and is only used to load the other main configs. Nothing else should be added to it., _(*13)

config/application.php is the main config file that contains what wp-config.php usually would. Base options should be set in there., _(*14)

For environment specific configuration, use the files under config/environments. By default there's is development, staging, and production but these can be whatever you require., _(*15)

The environment configs are required before the main application config so anything in an environment config takes precedence over application., _(*16)

Note: You can't re-define constants in PHP. So if you have a base setting in application.php and want to override it in production.php for example, you have a few options:, _(*17)

Remove the base option and be sure to define it in every environment it's needed
Only define the constant in application.php if it isn't already defined.

Don't want it?

You will lose the ability to define environment specific settings., _(*18)

Move all configuration into wp-config.php
Manually deal with environment specific options
Remove config directory

Environment Variables

PHP dotenv is used to load the .env file. All variables are then available in your app by getenv, $_SERVER, or $_ENV. The post-install-cmd and post-root-package-install scripts will automatically generate and set your salts in .env when:, _(*19)

The .env file doesn't exist
The .env file exists, but doesn't contain anything.

Another benefit of Forge is the ability to set environment variables within the UI. The required vars are as follows., _(*20)

DB_USER
DB_NAME
DB_PASSWORD

Both the .env variables and the ones set within the UI are available in $_ENV., _(*21)

Don't want it?

You will lose the separation between config and code and potentially put secure credentials at risk., _(*22)

Composer

Composer is used to manage dependencies. Bedrock considers any 3rd party library as a dependency including WordPress itself and any plugins., _(*23)

See these two blogs for more extensive documentation:, _(*24)

Screencast ($): Using Composer With WordPress, _(*25)

Plugins

WordPress Packagist is already registered in the composer.json file so any plugins from the WordPress Plugin Directory can easily be required., _(*26)

To add a plugin, add it under the require directive or use composer require <namespace>/<packagename> from the command line. If it's from WordPress Packagist then the namespace is always wpackagist-plugin., _(*27)

Example: "wpackagist-plugin/akismet": "dev-trunk", _(*28)

Whenever you add a new plugin or update the WP version, run composer update to install your new packages., _(*29)

plugins, and mu-plugins are Git ignored by default since Composer manages them. If you want to add something to those folders that isn't managed by Composer, you need to update .gitignore to whitelist them:, _(*30)

!public/app/plugins/plugin-name, _(*31)

Note: Some plugins may create files or folders outside of their given scope, or even make modifications to wp-config.php and other files in the app directory. These files should be added to your .gitignore file as they are managed by the plugins themselves, which are managed via Composer. Any modifications to wp-config.php that are needed should be moved into config/application.php., _(*32)

Updating WP and plugin versions

Updating your WordPress version (or any plugin) is just a matter of changing the version number in the composer.json file., _(*33)

Then running composer update will pull down the new version., _(*34)

Themes

Themes can also be managed by Composer but should only be done so under two conditions:, _(*35)

You're using a parent theme that won't be modified at all
You want to separate out your main theme and use that as a standalone package

Under most circumstances we recommend NOT doing #2 and instead keeping your main theme as part of your app's repository., _(*36)

Just like plugins, WPackagist maintains a Composer mirror of the WP theme directory. To require a theme, just use the wpackagist-theme namespace., _(*37)

Don't want it?

Composer integration is the biggest part of Bedrock, so if you were going to remove it there isn't much point in using Bedrock., _(*38)

wp-cron

Bedrock disables the internal WP Cron via define('DISABLE_WP_CRON', true);. If you keep this setting, you'll need to manually set a cron job like the following in your crontab file:, _(*39)

*/5 * * * * curl http://example.com/wp/wp-cron.php, _(*40)

WP-CLI

Bedrock works with WP-CLI just like any other WordPress project would. Previously we required WP-CLI in our composer.json file as a dependency. This has been removed since WP-CLI now recommends installing it globally with a phar file. It also caused conflicts if you tried using a global install., _(*41)

The wp command will automatically pick up Bedrock's subdirectory install as long as you run commands from within the project's directory (or deeper). Bedrock includes a wp-cli.yml file that sets the path option to public/wp. Use this config file for any further configuration., _(*42)

Contributing

Everyone is welcome to help contribute and improve this project. There are several ways you can contribute:, _(*43)

Reporting issues (please read issue guidelines)
Suggesting new features
Writing or refactoring code
Fixing issues

The Versions

04/05 2016

dev-master

9999999-dev http://anchour.com

A modern WordPress stack

project bedrock

A modern WordPress stack

anchour/bedrock

The README.md

Bedrock

What's This For?

Quick Start

Features

Requirements

Installation/Usage

Using create-project

Manually

Documentation

Folder Structure

Configuration Files

Don't want it?

Environment Variables

Don't want it?

Composer

Plugins

Updating WP and plugin versions

Themes

Don't want it?

wp-cron

WP-CLI

Contributing

The Versions

dev-master

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

dev-develop

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.4

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.3

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.2.1

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.2

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.1

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.0.2

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.0.1

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

1.4.0

The Requires

by Scott Walkinshaw

by Ben Word

by Matt Robitaille

dev-feature/new-env-configuration

The Requires

by Scott Walkinshaw

Using `create-project`