Getting Started

Installing and setup of Radix

In case you are using ddev or lando you have to prefix the commands below with it.

  1. Enable the Drupal core required Single directory components and Serialization modules:

drush en sdc serialization -y

  1. Download and enable the Radix theme:

composer require 'drupal/radix:6.0.x-dev@dev'

  1. Create a sub-theme using Drush (Considering you are using drupal/recommended-project):

drush --include="web/themes/contrib/radix" radix:create SUBTHEME_NAME

  • Note that SUBTHEME_NAME is the name of the theme you'll be working with, make sure ideally the name is in lowercase letters.

  • Note the path in the --include flag, if your Drupal is installed in web directory following core-recommended project, it's fine, otherwise if you are using anything else like docroot change it accordingly.

  • Once you've run the radix:create command you'd be shown a caveat as shown below that walks you through the next steps:

  1. Set the default theme to your newly created theme:

drush then SUBTHEME_NAME -y; drush config-set system.theme default SUBTHEME_NAME -y

  1. Go to the newly created theme directory:

cd /web/themes/custom/SUBTHEME_NAME

  1. Switch to the appropriate node version using nvm:

nvm use

  • If you don't have the specific node version required by the theme you'll be shown a message like below: nvm use Found 'radix/web/themes/custom/SUBTHEME_NAME/.nvmrc' with version <lts/iron> N/A: version "lts/iron -> N/A" is not yet installed.

    You need to run nvm install lts/iron to install it before using it. Run nvm install lts/iron to make sure you have the latest LTS version of node 20 installed.

  1. Install the required packages:

npm ci

  1. In the root of the theme, create a copy of the .env.example and rename it to .env.local:

cp .env.example .env.local

  1. Update the DRUPAL_BASE_URL variable in your .env.local to point to your localhost address (this file is .gitignored by default to avoid conflicts) - e.g. myproject.local or myproject.ddev.site

  2. For the development phase:

npm run watch

  1. For the production phase:

npm run production
PreviousRequirementsNextIndividual files and directories

Last updated