README.md

WP-VVV

This is a Vagrant configuration for WordPress.

Introduction

This guide assumes some basic familiarity with the command line, the Git version control system and Vagrant.

There are many graphical tools allowing you to achieve the same results as the ones described here, but a step-by-step guide for those is outside the scope of this document.

Requirements

• Vagrant
• VirtualBox

Setup

This project should be added to the www directory in your VVV setup. If you've followed the guide to installing VVV, the directory may be reached by typing cd vagrant-local/www in the command line interface.

Now clone the project into the www folder:

$ git clone git@github.com:26B/wp-vvv.git my-project-name

This should create a new directory called my-project-name containing all the project files.

Add the site to your vvv-custom.yml (if you don't know what this is, check out the documentation):

my-project-name:
  hosts:
    - my-project-name.test

We're not done yet: VVV needs to setup and incorporate the project into its configuration. That is achieved by running:

$ vagrant provision --provision-with site-my-project-name

Further configuration

You can configure your site right from the YAML block you just entered, just use the custom: key to set your particular settings. For example, let's say you want a different database name (other than the default that is created using the site name):

my-project-name:
  hosts:
    - my-project-name.test
  custom:
    db_name: special_db_name

That's all you need!

The following table specifies all the variables you can set in vvv-custom.yml and their respective defaults.

Variable	Description	Possible Values	Default
site_title	The site's title	Any string	Primary domain
wp_type	Type of installation	single, subdirectory, subdomain	single
db_name	Database name	Valid MySQL database name	[escaped_vvv_site_name]_dev
db_user	Database user		wp
db_password	Database password for user		wp
db_host	Database hostname	Hostname	localhost
db_charset	Database charset	MySQL Charset Sets and Collation	utf8mb4
db_collate	Database collation	MySQL Charset Sets and Collation	utf8mb4_general_ci
table_prefix	Database table prefix		wp_
wp_plugins	The plugins to activate
wp_theme	The theme to activate

What now?

This project is meant to be all about giving you a head start in setting up the WordPress environment for development. It also provides several helpful scripts and tries to make good choices in what is setup for you.

There's no theme dude!

You're darn right! There is no themes folder at all, so you are free to plug in any theme base/starter you'd like.