Este projeto é um Design System baseado em React e TypeScript, utilizando TSDX para compilação, Storybook para documentação e Jest para testes automatizados.
npm install wca-designsystemsh
Clonar o repositório
git clone http://wcavmdevops:82/WCA/_git/WCA.DesignSystem
cd wca-designsystem
Instalar dependências
npm install
ou
yarn install
`
Storybook, para poder ver os componentes
Para visualizar a documentação interativa dos componentes:
`sh
npm run storybook
ou
yarn storybook
`
O Storybook estará disponível em http://localhost:6006/.
Executando os Testes
Para rodar os testes unitários com Jest:
`sh
npm run test
ou
yarn test
`
Linter e Formatação
Verifique o código com ESLint:
`sh
npm run lint
ou
yarn lint
`
Publicação
Para publicar uma nova versão do Design System no NPM:
`sh
npm run deploy
ou
yarn deploy
`
---
Isso irá gerar uma nova versão irá atualizar a versão e subir para o NPM vinculado ao projeto.
`sh
https://www.npmjs.com/package/wca-designsystem
`
Para conseguir subir o projeto, o usuário tem que estar logado no NPM, e precisa fazer parte da organização acima.
`sh
npm login
``