Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.2 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.2 KB

GuardianConnector Shared Resources Library

npm version npm downloads License Nuxt

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

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 npm run dev:prepare
  2. In your Nuxt application, run npm 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
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Create a npm symlink
npm run link

# Run Prettier
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release