Jbxartemis NPM

JBXArtemis

Suite of components of the design system of the Jukebox Agenciamento.

To install the JBXArtemis library, simply use the following command:

yarn install jbxartemis

The JBXArtemis library can be used in different ways, depending on the configuration of your project:

To use the library as an ES module, you can import it as follows:

// main.js or YourComponent.vue
import 'jbxartemis/dist/style.css';

// YourComponent.vue
import { Component } from 'jbxartemis'

export default {
  components: {
    Component,
  },
}

To use the library as a UMD module, you can require it as follows:

const { Component } = require('jbxartemis');

Create css file to new component in src/assets/components/{component-name}.css
Import new css file in main.css after last import:

@import './components/{component-name}.css';

yarn install

yarn dev

yarn build

yarn test:unit

All tests are found in the directory: src/components/__tests__

yarn test:e2e:dev

This runs the end-to-end tests against the Vite development server. It is much faster than the production build.

But it's still recommended to test the production build with test:e2e before deploying (e.g. in CI environments):

yarn build
yarn test:e2e

yarn lint

To run Storybook, use the command npm run storybook.

yarn storybook

To build Storybook for production, use the command npm run build-storybook.

yarn build-storybook

3 years ago

3 years ago

3 years ago

3 years ago