annalgc-storybook
v0.0.1
Published
[![Build Status](http://corp-jenkins01.compute.br-sao-1.cvccorp.cloud:8080/buildStatus/icon?job=MS%2Flib-fe-react-bkf-opera)](http://corp-jenkins01.compute.br-sao-1.cvccorp.cloud:8080/job/MS/job/lib-fe-react-bkf-opera/) [![Quality Gate](https://sonar.app.
Downloads
3
Readme
lib-fe-react-bkf-opera
Boilerplate para criar bibliotecas React usando Typescript e o framework Vite, com uma estrutura básica pronta para a infraestrutura da CVC CORP.
Dependências
- Chui (Library components)
- Typescript (Programming language)
- Vite (Framework web)
- Nginx (Web Server)
- Docker (Container)
- Kubernetes (Container orchestration)
Instalação e execução
Instalação de dependências:
npm i
npm run storybook
Buildar a biblioteca
Para buildar a biblioteca, simplesmente execute o comando de build com o npm
npm i
npm build
Execução de testes
Os comandos para execução dos testes podem ser chamados manualmente através do comando:
npm run test
Publicação do pacote
Todos os pacotes são publicado no nexus, para publicar basta executar o seguinte comando:
npm run publish
IMPORTANTE
Você pode observar que o boilerplate possui um arquivo na raiz chamado package-lock_backup.json . Ao começar o desenvolvimento da biblioteca, caso os comandos acima funcionem corretamente, pode excluir esse arquivo. Caso algum desses comandos falhe, substitua seu package-lock pelo backup, remova a pasta node_modules e rode npm install novamente.
Por que isso pode ser necessário?
Quando você instala uma dependencia em um projeto de nodejs, as versões que são instaladas de fato são controladas no package-lock. O package.json é apenas uma instrução para buscar versões compativeis com as especificadas. Dessa forma, ao rodar o npm install a primeira vez com o primeiro comando especificado aqui nesse documento, você está instalando as ultimas versões disponíveis que são compatíveis (pelo versionamento semântico) com as especificadas via package.json. Pelo versionamento semantico elas deveriam funcionar, mas caso alguma versão seja incompatível, ao substituir o package-lock será instalado algumas versões anteriores que se mostraram compatíveis.
NÃO REMOVA O PACKAGE-LOCK.JSON APÓS O DESENVOLVIMENTO DA BIBLIOTECA TER SIDO INICIADO
Infraestrutura
Ambientes
- Desenvolvimento: https://lib-fe-react-bkf-opera.k8s-ti-cvc.com.br/health
- Homologação: https://lib-fe-react-bkf-opera.k8s-qa-cvc.com.br/health
- Produção: https://lib-fe-react-bkf-opera.k8s-cvc.com.br/health
Sonar
Jenkins
Vault
- Desenvolvimento: http://vault-dev.services.cvc.com.br:8200/ui/vault/auth?with=token
- Homologação: http://vault-qa.services.cvc.com.br:8200/ui/vault/auth?with=token
- Produção: http://vault-prod.services.cvc.com.br:8200/ui/vault/auth?with=token
Consul
- Desenvolvimento: http://consul-dev.services.cvc.com.br:8500/ui/
- Homologação: http://consul-qa.services.cvc.com.br:8500/ui/
- Produção: http://consul-prod.services.cvc.com.br:8500/ui/