Table of Contents
Ripple Framework is a collection of Nuxt modules and layers primarily used to create headless SDP websites using the Tide Drupal CMS and Ripple Design System.
Ripple Framework provides components, patterns and tools for building brand Victoria digital products. Developed by the Single Digital Presence (SDP) team within the Department of Government Services, Ripple Framework strives to:
- make it easier for citizens to find, understand and use government information
- ensure users can easily navigate sites regardless of technical ability, location or device
- allow designers and developers to create consistent Brand Victoria digital products
- increase the speed of delivery for digital products and services
Over 50 government websites use Ripple Framework to date, including our main vic.gov.au platform. These sites attract the visitation of millions of views per month.
Components are built using Vue 3 and TypeScript.
The monorepo is managed with pnpm workspaces, using Node.js.
Tests are written using Vitest and Cypress.
We use custom rules for ESLint and Stylelint that come from the main Ripple repository.
Ripple Framework is a series of packages to enable the development of Drupal-backed sites for SDP using Nuxt. An example Nuxt application using Ripple Framework packages can be found here example-nuxt-app.
The Ripple Framework's Nuxt packages are included by first npm installing them, then adding them to the extends section of the nuxt.config.ts file, for example:
import { defineNuxtConfig } from 'nuxt/config'
export default defineNuxtConfig({
extends: [
'@dpc-sdp/nuxt-ripple',
'@dpc-sdp/ripple-sdp-core'
]
})Note: Ripple Framework will only be hosted on Github Packages, any packages still published to npm are either pre-release or deprecated, and should not be used. Please see the section Access to Github Packages repos for instructions on how to set up a personal access token, and where to use it.
See https://www.ripple.sdp.vic.gov.au/ for more information about the Ripple design system.
For information about using Ripple in SDP websites see the Ripple Framework section.
Please see CONTRIBUTING.md as well as https://www.ripple.sdp.vic.gov.au/design-system/develop/contributing/ for information about how to submit changes to Ripple.
Distributed under the Apache 2.0 License. See LICENSE for more information.