Luppa-ui NPM | npm.io

LUPPA - UI KIT

Sobre

O LUPPA UI documenta e distribui componentes de interface que definem a linguagem visual da plataforma LUPPA.

Utilização

Para utilizar o LUPPA UI, deve primeiramente instalar as dependências necessárias por meio do npm ou yarn.

Instalar

Siga o exemplo a seguir para proceder com a instalação.

# NPM
npm install

# Yarn
yarn

Storybook

Para visualizar os componentes é possível utilizar o storybook, a ferramenta permite a documentação e teste dos componentes. Siga a instrução abaixo de acordo com o ambiente desejado.

Ambiente de Desenvolvimento

No ambiente de desenvolvimento o storybook estará disponível no localhost:8080. Funcionalidade de watch e alto-reload estão habilitadas nesse modo.

# NPM
npm start

# Yarn
yarn start

Ambiente de Produção

No ambiente de produção o storybook será compilado na pasta /storybook-static disponível na raiz do projeto.

# NPM
npm run build:storybook

# Yarn
yarn build:storybook

Distribuição

A distribuição do LUPPA UI sempre será em ambiente de produção, para isso devemos compilar e distribuir o pacote, por meio do seguinte comando.

# NPM
npm run pre-publish
npm publish

# Yarn
yarn pre-publish
yarn publish

O gerenciador de pacotes desejado pedirá pelo login e senha e qual a nova versão do pacote. O resultado da compilação é adicionada no diretório /dist, mas a distribuição é feita pelo npm registry cadastrado.