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
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.