Local Setup Quickstart - Vanilla Success

/* * These styles apply ONLY to the header and footer assets. */ * { padding: 0; margin: 0; box-sizing: border-box; } .footer { background: #f5f5f6; color: #555a62; font-size: 14px; line-height: 1.5; padding: 18px 0; } .footer-wrap { padding-left: 18px; padding-right: 18px; max-width: 1236px; margin: 0 auto; } .footer a { color: #0291db; } .footer a:hover { color: #0276b3; } .footer-row { display: flex; flex-wrap: wrap; justify-content: space-between; align-items: center; margin: -3px; } .footer-col { padding: 0 3px; } .footer-col-copyRight { justify-content: flex-start; } .footer-col-logo { justify-content: flex-end; } .footer-col-copyRight, .footer-col-logo { flex: 1; display: flex; } .logo { width: 120px; height: 28px; opacity: 0.6; } @media screen and (max-width: 768px) { .footer-row { display: block; } .footer-col { width: 100%; text-align: center; margin: 6px 0; } .footer-col:first-child { margin-top: 0; } .footer-col:last-child { margin-bottom: 0; } .footer-col-copyRight, .footer-col-logo { justify-content: center; } .logo { margin: 0 auto; } } /*# sourceMappingURL=styles.css.map */

Vanilla has only 1 supported localhost installation configuration, Vanilla Docker.

Vanilla Docker

Vanilla Docker is a self-container docker-compose setup providing:

PHP
MySQL
Nginx
Memcached
Sphinx
XDebug
Local SSO & Embedding Stubs

Prerequisites

Docker installed.
Node 12.x installed.
Yarn 1.15+ installed.
- Note for MacOS users: It is not recommended to install yarn through Brew, as it may automatically install an unsupported node version. Instead it is recommended to install through NPM as follows:

npm install -g yarn

Setting up Vanilla Docker

Follow Vanilla Docker's setup guide.

Installing Dependencies & Building

The next step is to install composer dependencies & node_modules, then build the frontend.

cd vanilla-dir
composer install

The first time you run this, it may take a while. Subsequent runs should be faster, but if you are constantly updating the javascript or CSS or addons or themes, it's recommended to use the developer build.

# Add This to you config.php
# $Configuration['HotReload']['Enabled'] = true;

# The run this
yarn build:dev

Setting up XDebug w/ PHPStorm

See Make XDebug work with PhpStorm.

Running Unit Tests w/ PHPStorm

See Make unit tests work within PhpStorm.

Installing an Addon

See Installing Addons.