Nuxt Ripple
A Nuxt module for integrating Ripple and Tide, this package loads
@dpc-sdp/ripple-ui-coreand@dpc-sdp/ripple-ui-forms.
Installation
To use this package in your Nuxt project first install it with npm
npm install @dpc-sdp/nuxt-rippleUsage
Add the installed package in your sites nuxt.config.js file under the extends property, this includes the package as a Nuxt Layer.
export default defineNuxtConfig({
extends: [
'@dpc-sdp/nuxt-ripple'
]
})Configuration
Runtime variables can be set in your sites nuxt.config.js file under the tide property.
export default defineNuxtConfig({
runtimeConfig: {
public: {
API_URL: '',
tide: {
site: '8888',
baseUrl: 'https://develop.content.reference.sdp.vic.gov.au',
config: {
apiPrefix: '/api/v1',
auth: {
username: 'dpc',
password: 'sdp'
}
}
}
}
}
})They can also be set as uppercase environment variables starting with NUXT_ and using _ to separate keys and case changes.
NUXT_PUBLIC_TIDE_SITE=8888
NUXT_PUBLIC_TIDE_BASE_URL=https://develop.content.reference.sdp.vic.gov.au
Robots.txt
The robots.txt file is handled automatically by @dpc-sdp/nuxt-ripple, but can be overridden and extended via the nuxt.config if needed.
import { createResolver } from '@nuxt/kit'
const { resolve } = createResolver(import.meta.url)
export default defineNuxtConfig({
robots: {
configPath: resolve('./robots.config.ts')
}
})import rules from '@dpc-sdp/nuxt-ripple/robots'
export default [
// optionally include, filter or map the default rules
...rules,
// add addtional rules
{ UserAgent: 'SomeCustomBot', Disallow: '/' }
]