cavilha-ui v0.0.1-alpha.3
Cavilha UI
1. Primeiros passos:
1.1 Instalando as ferramentas
- Ultima versão do Visual Studio Code
- Node latest
Para se certificar que o Node encontra-se instalado, abra o terminal e digite: node -v;
1.2. Rodando o projeto localmente
Para instalar as dependências dentro do Cavilha rode yarn. Com todas as dependências instaladas, rode yarn dev para iniciar o servidor local de desenvolvimento em http://localhost:3000.
2. Publicação do pacote e Deploy da documentação na Vercel
Este projeto utiliza das pipelines do Gitlab CI/CD. Qualquer commit dentro da branch master dispara uma pipeline para efetuar o build e publicação do pacote do cavilha-ui no NPM, assim como o build e publicação da documentação do Storybook na Vercel.
Esta interação pode ser editada via mm-webstore-lerna/.gitlab-ci.yml. No caso de se utilizar o GitHub, configurar as actions com base neste arquivo.
Sobre este projeto
Este projeto abstrai os componentes criados no Cavilha Design System em uma biblioteca de componentes React que por si são exportados como módulos ES para o pacote cavilha-ui. Este pacote será publicado para uso privado no NPM.
O rollup.js é o empacotador responsável por compilar os arquivos dentro de ./src e exportá-lo dentro de build. Durante o processo de desenvolvimento isso é automátizado a cada modificação dos componentes através da flag -w do script build-watch.
O que tem dentro?
/.storybook : Contem os arquivos de configuração de estilo, tematização e webpack do Storybook.
/build : Contem os arquivos empacotados pelo rollup.
/src : Contem a pasta de componentes e o ponto de entrada dos arquivos a serem empacotados.
/src/components : Contem a pasta de componentes e o ponto de entrada dos arquivos a serem empacotados.
/stories : Contem a documentação de cada componente via Storybook.