Describes how to use the CWP Wātea theme
Install this theme module with Composer:
composer require cwp/watea-theme
This will also install the
cwp/starter-theme dependency, which is the foundation for this subtheme.
The installation of
cwp/agency-extensions is suggested as it provides additional functionality to the CMS for agency-style SilverStripe websites.
This theme is designed to augment the base functionality and framework provided by the CWP Starter theme. As such, all of the documentation for the CWP Starter theme is relevant to this theme as well. We suggest you familiarise yourself with this documentation.
If you need to modify template markup from the SilverStripe framework, other modules or even the Starter theme, you can copy them into the "watea" subtheme directory and modify them there.
Please familiarise yourself with Customising the starter theme, as all documentation there is relevant for this subtheme as well.
For development you will need Node.js and npm installed. Please see the Customising the starter theme article for more information.
Next, you need to install the required npm packages. You will need to do this both in the CWP Starter theme and in the "watea" subtheme, as this subtheme imports components from the "starter" theme during Sass building. Ensure you have changed each theme's directory first:
cd themes/starter npm install cd ../watea npm install
This theme and the base-theme also come with the
cwp/agency-extensions module which helps us to clean up some parts of the CMS, rename some settings fields and provide a little bit of extra functionality to help the Wātea theme work.
If you need to extend or modify these changes at all, you can control the theme's extensions with YAML configuration, or create your own extensions in your
Similarly to the CWP Starter theme, you can compile assets using npm commands:
npm run build # Produces unminified (development) distributable files in dist/ npm run package # Produces minified (production) distributable files in dist/
Or to "watch" for changes in real time as you develop (faster):
npm run watch # Compiles as "build", then watches for changes and recompiles as necessary
For CSS, this theme contains a fully compiled set of styles for both themes. You should only include this theme's CSS (not the CWP Starter theme).
To be able to "npm run build" in the Wātea theme, you will also be required to have run "npm install" in the CWP Starter theme.
npm run lint-js npm run lint-sass
For information on the rules and configuration around these linters, please see the CWP Starter theme documentation regarding "working with standards".