jeffesonmaia / roots-example-project.com

Example project that uses Bedrock, Trellis, and Sage

Roots Example Project

This repository is an example of how to integrate and use the following projects together:

• Bedrock
• Trellis
• Sage (with Soil)

For more background, see this blog post.

This project is a complete working example that's deployed on a Digital Ocean 512MB droplet.

You can view it at http://roots-example-project.com/.

Instructions

This project can be cloned and re-configured to fit your needs but we highly suggest you follow in the instructions below to create your own. This will guarantee you have the latest version of Bedrock, Trellis, Sage, and Soil in case this example falls behind a little.

Here's how this example project was created:

1. Create a new project directory: $ mkdir example.com && cd example.com
2. Clone Trellis: $ git clone --depth=1 [email protected]:roots/trellis.git && rm -rf trellis/.git
3. Clone Bedrock: $ git clone --depth=1 [email protected]:roots/bedrock.git site && rm -rf site/.git
4. Clone Sage: $ git clone --depth=1 [email protected]:roots/sage.git site/web/app/themes/sage && rm -rf site/web/app/themes/sage/.git

After that your folder structure is complete and you're ready to configure the individual components.

Bedrock

Bedrock doesn't need any additional configuration by default. There's only one custom option set in this example: WP_DEFAULT_THEME.

• In site/config/application.php add define('WP_DEFAULT_THEME', 'sage');

Trellis

Trellis' instructions apply here, but more specifically:

1. Make sure you have the requirements all installed
2. Install the Ansible Galaxy roles: $ cd trellis && ansible-galaxy install -r requirements.yml
3. Configure your wordpress_sites - see the Local Development Setup docs

Staging/Production

If you also want staging/production servers, create those manually at this point.

1. Add their hostnames/IPs to ansible/hosts/<environment>
2. Configure their wordpress_sites just like #3 above and follow the Remote Server Setup docs
3. Define your SSH keys to give users the ability to deploy, see the SSH Keys docs

Provision

Development

1. Run vagrant up

Staging/Production

1. Provision server: ansible-playbook -i hosts/<environment> server.yml
2. Deploy your site: ./deploy.sh <environment> <site name>

Naming

Some notes on names used throughout this project:

• You're encouraged to rename Sage to your theme name. Just remember to rename references to it everywhere.
• Any time you see a name like "example.com", "example.dev", "roots-example-project.com", etc, it should be renamed to your project name.
• <environment> is a placeholder to be replaced by staging or production (for example).

Sage/Theme

1. Install Sage's requirements
2. SSH into VM: $ vagrant ssh
3. Add the Soil plugin: $ cd /srv/www/roots-example-project.com/current && composer require roots/soil dev-master (note: non-development use requires a license that you can purchase on the Roots site)
4. Activate Soil: $ wp plugin activate soil
5. Configure Sage and customize the theme as usual. At a minimum, do this on your host/local machine:

$ cd web/app/themes/sage
$ npm install
$ bower install
$ gulp