README

This module adds support for the NSW Design System to a Silverstripe website.

If you are a NSW Government Agency using Silverstripe Framework and/or CMS, this is the module to use.

This module is maintained by the NSWDPC Digital Team. We're a friendly crew that welcomes pull/merge requests and issue reports via Github.

Features

✅ Implements all components from the NSW Design System v3.x
✅ Standard page layouts based on template examples
✅ Integrates our supported Elemental content blocks
✅ Includes the NSWDPC Silverstripe content authoring boilerplate containing content authoring tools.
✅ Forms: supports all Silverstripe form fields plus our supported form field extensions
✅ Adds SlimSelect for <select multiple> support
✅ A simple frontend build process using Yarn or NPM
✅ Themes and templates: supports adding project-specific JS and SCSS requirements to the build, including templates and settings overrides
✅ Branding: full support for Masterbrand, Co-brand and Independent entities within the NSW branding guidelines.

Starting within a standard Silverstripe v4 installation, install via Composer.

composer require nswdpc/waratah:~1.1.0

composer require nswdpc/waratah:~1.0.0

See _config directory for default configuration settings

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.