Nuxt 3 Core Layer - SBC Connect Common

This layer was created to enhance developer experience when creating BCROS/SBC applications.

Included are items such as:

• The BC Gov color theme
• BCSans fonts
• BC favicon
• BC Gov logos
• Header and Footer components with relevant child components
• Keycloak integration
• Account Store with Pinia
• Internationalization

Also included are several common npm packages and nuxt modules.

• Nuxt UI
• Nuxt Content
• Nuxt I18n
• Pinia
• Pinia Persisted State
• VueUse
• Keycloak
• Zod

Development

Create a fork and local copy of this repo. Answer Y to create a local clone.

gh repo fork bcgov/sbc-connect-common

Change into the directory and install the packages.

pnpm install

Start the development environment.

pnpm run dev

Testing

Run Vitest in watch mode for unit tests

pnpm test
or
pnpm test:unit

How to Contribute

If you would like to contribute, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Working on the layer

Your layer is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.

The .playground directory should help you on trying your layer during development.

Running pnpm dev will prepare and boot .playground directory, which imports your layer itself.

Distributing the layer

Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.

To do so, you only have to check if files in package.json are valid, then run:

npm publish --access public

Alternatively, you can run:

pnpm run publish <version>

Where <version> is either patch, minor or major. This will take care of package.json and update the version number for you, as well as publish to npm.

Once published, users can install the layer with:

npm install --save @sbc-connect/nuxt-core-layer

Then add the dependency to their extends in nuxt.config:

defineNuxtConfig({
  extends: '@sbc-connect/nuxt-core-layer'
})

License

Copyright © 2024 Province of British Columbia

Licensed under the BSD 3 Clause License, (the "License"); you may not use this file except in compliance with the License. The template for the license can be found here https://opensource.org/license/bsd-3-clause/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.