## 1. Project Overview & Quickstart (Varying-Vagrant-Vagrants/VVV)

# VVV

[](https://www.codacy.com/gh/Varying-Vagrant-Vagrants/VVV?utm_source=github.com&utm_medium=referral&utm_content=Varying-Vagrant-Vagrants/VVV&utm_campaign=Badge_Grade) [](http://isitmaintained.com/project/varying-vagrant-vagrants/vvv "Average time to resolve an issue") [](http://isitmaintained.com/project/varying-vagrant-vagrants/vvv "Percentage of issues still open")

VVV is a local developer environment, mainly aimed at [WordPress](https://wordpress.org) developers. It uses [Vagrant](https://www.vagrantup.com) and Docker/VirtualBox/Parallels/HyperV to create a linux server environment for building sites, and contributing to WordPress itself.

_VVV stands for Varying Vagrant Vagrants._

## How To Use

To use it, download and install [Vagrant](https://www.vagrantup.com) and a provider such as [VirtualBox](https://www.virtualbox.org/), Docker, or Parallels Pro. Then, clone this repository and run:

```shell
vagrant plugin install --local
vagrant up --provision
```

This will create a VM capable of hosting sites.

When it's done, visit [http://vvv.test](http://vvv.test) to see the default sites, or add a new site via `config/config.yml` and it will create a new site under the `www` subfolder.

The online documentation contains more detailed [installation instructions](https://varyingvagrantvagrants.org/docs/en-US/installation/).

* **Web**: [https://varyingvagrantvagrants.org/](https://varyingvagrantvagrants.org/)
* **Contributing**: Contributions are more than welcome. Please see our current [contributing guidelines](https://varyingvagrantvagrants.org/docs/en-US/contributing/). Thanks!

## Minimum System requirements

[For system requirements, please read the system requirements documentation here](https://varyingvagrantvagrants.org/docs/en-US/installation/software-requirements/)

## Software included

For a comprehensive list, please see the [list of installed packages](https://varyingvagrantvagrants.org/docs/en-US/installed-packages/).

## 2. Official Technical Reference & Guides (Varying-Vagrant-Vagrants/Varying-Vagrant-Vagrants.github.io)

# varyingvagrantvagrants.org

[](https://travis-ci.org/Varying-Vagrant-Vagrants/varyingvagrantvagrants.org) [](https://www.codacy.com/gh/Varying-Vagrant-Vagrants/varyingvagrantvagrants.org?utm_source=github.com&utm_medium=referral&utm_content=Varying-Vagrant-Vagrants/varyingvagrantvagrants.org&utm_campaign=Badge_Grade)

This repository provides the code and content for [varyingvagrantvagrants.org](https://varyingvagrantvagrants.org), [VVV](https://github.com/Varying-Vagrant-Vagrants/vvv)'s official website.

The `main` branch of this repository deploys to production under [varyingvagrantvagrants.org](https://varyingvagrantvagrants.org). It also pulls the [CONTRIBUTING.md](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/develop/.github/CONTRIBUTING.md) and [CHANGELOG.md](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/develop/CHANGELOG.md) files from the `develop` branch of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV).

Pull requests can be opened against this repository for the following:

* Issues with deployment configuration through Travis CI.
* Issues with Jekyll configuration.
* Updates to the varyingvagrantvagrants.org home page.
* Updates to varyingvagrantvagrants.org blog posts.
* Updates to VVV documentation.

Once a pull request is merged to `master`, Travis CI is used to deploy the built site files to an AWS S3 bucket. Nginx is used to direct traffic to the correct branch directory in the bucket.

Issues to discuss changes to the code and documentation should be opened at the main [VVV repository](https://github.com/Varying-Vagrant-Vagrants/vvv).

## Testing and Building

Use this command to run a local instance for writing docs:

```sh
bundle exec jekyll serve
```

It will give you a URL to visit in your browser, and rebuilds the docs and stylesheets when files change.

The site is auto-deployed by Travis when the `main` branch is updated.