Skip to content

Bootstrap derived sub-theme aligned for use with the Web Experience Toolkit jQuery Framework.

Notifications You must be signed in to change notification settings

olstjos/wxt_bootstrap

 
 

Repository files navigation

WxT Bootstrap

A modern, component based and accessible theme powered by the Bootstrap base theme and integrated extensively with the WxT jQuery Framework.

This theme will strive to always work with the native Drupal 8 workflow which consists of leveraging block layouts and twig templates by default. Over time full support for various contributed modules such as Display Suite and Panels will be added for more complex layout functionality.

Note: For up-to-date documentation please always consult our README.md file.

Installation

There are two possible installation methods to leverage the WxT Bootstrap theme in Drupal 8:

  • distribution (recommended)
  • standalone

The standalone install is provided as an additional installation method for those who do not wish to have the full weight of a distribution and its required dependencies.

Distribution

All dependencies are included as part of the Drupal WxT distribution and come completely configured alongside with additional integrations and workflow improvements.

  • WxT (8.x-1.x)

StandAlone

WxT Library at a minimum requires the following dependencies:

Note: The wet-boew assets need to be under the /libraries folder with the proper naming scheme.

You can easily retrieve these dependencies via composer:

composer require drupal/wxt_bootstrap

Note: We heavily recommend that you use the distribution method. Limited support is provided for standalone.

  • Extra configuration of WxT components and additional custom plugins
  • Drupal application lifecycle and timely updates of core and additional Lightning extensions
  • Workflow improvements from Lightning and configuration of key contributed modules

Setup

Enable either The WxT Bootstrap theme or derived sub-theme and set it to be the default active theme in Drupal.

Sub-Theming

We provide a starterkit under the starterkits folder that contains the template for inheriting from wxt_bootstrap.

Sass Compilation

You will need to have the following required dependencies for the following commands to execute successfully:

  • NodeJS (v11.0.0) + NPM (v6.4.1) + Yarn (v1.17.3)
  • Grunt or Gulp install globally with the -g option

Inside the theme directory run the following to install the required NodeJS dependencies:

yarn install

Pre-requisites

Download and extract the latest 3.x.x version of Bootstrap Framework Source Files into the root of your new sub-theme. After it has been extracted, the directory should be renamed (if needed) so it reads ./wxt_bootstrap/libraries/bootstrap. Even though WxT ships with the compiled bootstrap files as libraries we still need the source files to compile the bootstrap overrides.

Option 1: With Gulp (Preferred + Tested)

Run the following commands inside the theme directory to compile SASS to CSS:

  • gulp sass (Creates the initial css file)
  • gulp sass:watch (Watches the sass folder for changes)

Option 2: With Grunt (Needs Work)

Run the following commands inside the theme directory to compile SASS to CSS:

  • grunt init (Creates the initial css file)
  • grunt watch (Watches the sass folder for changes)

BROWSERSYNC

Adding Browsersync to workflow

  1. Install the Drupal browsersync module from: https://www.drupal.org/project/browsersync

  2. In "Themes" -> "Appearance" -> "Settings" scroll down and enable browsersync for the appropriate theme.

  3. Edit the proxy address in the gruntfile.js / gulpfile.js file to match the IP or hostname of your Drupal website.

  4. Run grunt browsersync or gulp browsersync (Watches the sass folder, and sets up a browsersync session.)

About

Bootstrap derived sub-theme aligned for use with the Web Experience Toolkit jQuery Framework.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Twig 79.0%
  • PHP 9.5%
  • SCSS 5.2%
  • CSS 4.7%
  • JavaScript 0.8%
  • Ruby 0.8%