0.0.2-alpha.0 • Published 3 years ago

@aveonline/ui-vue v0.0.2-alpha.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Getting started

npm install @aveonline/ui-vue @fortawesome/fontawesome-svg-core

Usage with tailwind

Import things into your JS app from the @aveonline/ui-vue package.

import { createApp } from 'vue'
import { library } from '@fortawesome/fontawesome-svg-core'

import { icons } from '@aveonline/ui-vue'

library.add(icons)

createApp(App).mount('#app')

tailwind.config.js

module.exports = {
  content: ['./node_modules/@aveonline/ui-vue/dist/*.js']
}

Usage without tailwind

Import things into your JS app from the @aveonline/ui-vue package.

import '@aveonline/ui-vue/tailwind.css' // import this at main root
import { createApp } from 'vue'
import { library } from '@fortawesome/fontawesome-svg-core'

import { icons } from '@aveonline/ui-vue'

library.add(icons)

createApp(App).mount('#app')

Developing @aveonline/ui-vue

Developing locally against Storybook is easy; run npm run storybook.

FONTAWESOME_NPM_AUTH_TOKEN=[get token admin] npm install

Run npm link to watch the entire project for changes and recompile on the fly.

Tests

Run npm run test to execute all unit test components.

We use vitest and testing-library/vue for unit/integration tests and will soon use Chromatic for visual regression testing.

Production

Run npm run build:storybook to execute docs production.

Run npm run build:lib to execute ui-kit production.