@byu-oit/aim-nuxt-builder

aim-nuxt-builder

Builds out the fundamental pieces of the AIM application such as the page index, context switching, implicit grant authorization, and default page layout.

Installation

npm i @byu-oit/aim-nuxt-builder

The postinstall script will copy everything in the common directory to your current working directory in a src folder. If there are duplicates, they will be overwritten. If you believe a modification to one of these files is necessary, please make a pull request or submit an issue on the source repository

Documentation

Options may be given either in-line or declared on the top-level of the nuxt configuration object. In-line options will overwrite options declared on the top-level of the next configuration object. These options only apply to the current project and do not extend to other page builds.

The type definition for AIM builder options are here. The defaults are:

{
    modules?: string[]
    routes?: RouteConfig
}

Modules

A place to give the name of the modules to build along with the local project.

The pages must be installed and located correctly in the node_modules directory. The entry file of each module must export an object following the Config Type Definition.

NOTE: You may NOT define an index route in a page module as it will conflict with the AIM Index Page. Any page that conflicts with an existing page, will be ignored.

Contributing

Submit a PR with a fix or feature. Bug fixes must pass tests. New features must include new tests to prove their reliability. This helps in maintaining this library and prevents stale code.

Appendix

Definitions

Product: a grouping of web resources.

Web Resource: the metadata pertaining to a page.

Diagrams