Service BC Nuxt3 Admin Layer

This layer was created to simplify DX when creating Service BC applications. Currently this layer includes authentication with Firebase Auth and a default layout.

Local Dev Setup

Install the dependencies:

pnpm install

Development Server

Start the local server:

pnpm dev

Running Local Tests

Currently using Cypress for e2e tests and Vitest for unit tests.

e2e Tests

Dev server needs to be running for e2e tests. To open cypress test runner in electron window:

pnpm cy:open

Unit Tests

To run unit tests with vitest:

pnpm vi:run

Publishing to NPM

For a layer to be extended correctly, it must not include a 'scripts' section in the package.json. When publishing to npm, be sure to remove this before running the publish command.

Make sure you're signed in to the correct npm registry. Then run:

npm publish --access public

Alternatively, there is a publish script to avoid manually deleting the scripts section each time. Currently this script relies on having the initial package.json version and name set. Also you must be signed in (correct user/password and registry/account) for this script to run properly.

The 3rd argument is the release version (patch, minor, major).

To publish a patch release:

node scripts/publish.js patch

To publish a minor release:

node scripts/publish.js minor

To publish a major release:

node scripts/publish.js major

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.