VF-WP is a collection of WordPress themes and plugins that integrate with the Visual Framework. They are currently heavily tied to the brand-specific "VF 2.0 for the EMBL Design Language". Additional WordPress plugin dependencies are kept in an external repository (see below).
VF_EXTERNAL_PLUGINS_REPO_TAG
variable in .env
file.The Visual Framework WordPress theme uses a plugin-based architecture.
Blocks are small, reusable content patterns based on the Visual Framework.
Containers are large, single use template patterns based on the Visual Framework.
Templates are configurable container stacks that can be used to define preset dynamic theme templates.
Contributing to this repository requires command line tools:
To start:
# Install dev dependencies
yarn install
This project makes use of Visual Framework components to build its CSS and JavaScript.
These scripts and tasks are available:
yarn run update-components
To interactively update the Visual Framework components (and other npm packages).
gulp build
vf-components/vf-componenet-rollup/index.scss
wp-content/themes/vf-wp/assets/css/styles.css
vf-components/vf-componenet-rollup/scripts.scss
wp-content/themes/vf-wp/assets/scripts/scripts.js
Note: the CI will run gulp build
on commit to master
.
gulp default
To launch local development of the above with a watch
task.
gulp vf-gutenberg
To compile the Gutenberg React blocks.
git clone --recursive https://github.com/visual-framework/vf-wp.git
Use any of the below variation of command to build the site
bin/dev quick_group
- to build WordPress website with basic Visual Framework default configuration - Plugin/themes enabledbin/dev quick_group_bootstrap
- to build WordPress website setup with Visual Framework dummy microsite bootstrap versionbin/dev launch
- to launch browserbin/dev login
- to login in wordpress adminbin/dev logs
- tail logs from containersbin/dev pma
- launch phpMyAdmin to view databasebin/dev up
- to spin up docker containersbin/dev down
- to spin down docker containersbin/dev mailhog
- to launch mailhog to view e-mail sent my containersn.b. To develop locally you'll need to make sure your project's git submodules are up to date: git submodule update --init --recursive
.env
file.