npm.io
2.18.1 • Published 5d ago

@adminkitas/nuxt2-devkit

Licence
UNLICENSED
Version
2.18.1
Deps
13
Size
562 kB
Vulns
0
Weekly
0

@adminkitas/nuxt2-devkit

A shared development toolkit for Nuxt 2 applications used across Adminkit projects. It provides a standardized design system, plugins, configuration defaults, and common tooling to ensure consistency in styling and behavior.

How to setup

Run:

yarn add @adminkitas/nuxt2-devkit

or

npm i @adminkitas/nuxt2-devkit

Assets

Create a a file called style.scss in the folder /assets/styles.

Add the code:

@import '@adminkitas/nuxt2-devkit/assets/styles/fonts/gineto.css';
@import '@adminkitas/nuxt2-devkit/assets/styles/fonts/remixicon';
@import '@adminkitas/nuxt2-devkit/assets/styles/style';
nuxt.config.js

To meet the style and functionality we strive to achieve, do this to your nuxt.config.js file

import { buefy, plugins, breakpoints } from '@adminkitas/nuxt2-devkit/config';

export default {
  ...,
  css: ['@/assets/styles/style.scss'],
  plugins: [...plugins],
  buefy,
  breakpoints
}
Moment:

Moment.js comes with the package and is required to get the components to work.

buildModules:['@nuxtjs/moment'],
plugins: [ // this is allready injected through the plugins described above.
     { src: '~/node_modules/@adminkitas/nuxt2-devkit/plugins/moment.js', mode: 'client' }
  ]
i18n:

i18n comes with the package and is required when using the components.

import { i18n } from '@adminkitas/nuxt2-devkit/config';
export default {
  ...,
  modules:['@nuxtjs/i18n'],
  plugins: [ // this is allready injected through the plugins described above.
  ...,
  { src: '~/node_modules/@adminkitas/nuxt2-devkit/plugins/validation_i18n.js', mode: 'client' }
  ]
  i18n: i18n
}

Environmental setup

From @/node_modules/@adminkitas/nuxt2-devkit/ copy the folders .vscode & static into your own project

Available plugins

The package comes with a couple of extra widly used plugins:

plugins: [
  // To verify if a feature is available
  { src: '~/node_modules/@adminkitas/nuxt2-devkit/plugins/feature.js', mode: 'client' },

  // settings for vue-showdown
  {
    src: '~/node_modules/@adminkitas/nuxt2-devkit/vue-showdown.js',
    mode: 'client'
  }