GuardianConnector Shared Resources Library

Shared components (components, pages, assets, middleware and more) for GuardianConnector Nuxt.js applications.

• ✨  Release Notes

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add gc-shared-resources

That's it! You can now use GuardianConnector Shared Resources Library in your Nuxt app ✨

How to use this module

Unlike many Nuxt modules, this repository does not use a playground/ directory. Instead, this module should be used directly with a GuardianConnector Nuxt application.

For development purposes, utilize a symlink to this module in a Nuxt application to use your local code in runtime:

1. Generate type stubs by running pnpm run dev:prepare
2. In your Nuxt application, run pnpm link ../gc-shared-components (assuming your module and Nuxt application are in the same root directory, if not adapt the path)

Contribution

Local development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Create a (p)npm symlink
pnpm run link

# Run Prettier
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release