@byu-oit/nuxt-sis-access-management

Nuxt plugin the facilitates routing features specific to the Student Information Systems pages

Usage no npm install needed!

<script type="module">
  import byuOitNuxtSisAccessManagement from 'https://cdn.skypack.dev/@byu-oit/nuxt-sis-access-management';
</script>

README

Setup

Install

:warning: Requires Nuxt version >= 2.13 :warning:

Install with yarn:

yarn add @byu-oit/nuxt-sis-access-management

Install with npm:

npm install @byu-oit/nuxt-sis-access-management

nuxt.config.js

module.exports = {
    modules: [
        '@byu-oit/nuxt-sis-access-management',
    ],
}

Typescript

Add the types to your "types" array in tsconfig.json after the @nuxt/types (Nuxt 2.12.0+)

tsconfig.json

{
  "compilerOptions": {
    "types": [
      "@nuxt/types",
      "@byu-oit/nuxt-sis-access-management"
    ]
  }
}

Why?

Because of the way nuxt works the $axios property on the context has to be merged into the nuxt Context interface via declaration merging. Adding @byu-oit/nuxt-sis-access-management to your types will import the types from the package and make typescript aware of the additions to the Context interface.

Usage

Set the production environment variable in the nuxt.config file:

{
  publicRuntimeConfig: {
    production: process.env.PRODUCTION || true
  }
}