npm.io
7.2.0 • Published 1 year ago

@d1.cx/components

Licence
MIT
Version
7.2.0
Deps
1
Size
642 kB
Vulns
0
Weekly
0

Lib de Components

Aplicação que contém todos os components react que vão ser compartilhada nos micro front ends.

Como rodar o projeto

  1. Crie uma pasta no seu local de trabalho.
  2. Faça o clone do repositório:
git clone https://directoneapp@dev.azure.com/directoneapp/Thanos/_git/directone.app.d1-components.front
  1. Acesse a pasta via terminal:
cd directone.app.d1-components.front
  1. Instale as dependências:
npm install
  1. Com as dependências instaladas agora e só rodar o comando:
npm run storybook

Após rodar o comando acima o browser irá abrir no endereço:

http://localhost:6006

Como adicionar um novo componente

Todos os componentes devem estar dentro da pasta src, seguindo a seguinte estrutura:

  • NomeDoComponente.tsx
  • NomeDoComponente.stories.tsx
  • index.tsx
  • styled.tsx
  • types.ts
  • Componentes do ALTU seguem o mesmo padrão, porém deve ser adicionado o prefixo Altu em seus componentes e arquivos.

Importante ressaltar que a tipagem não deve ser declarada dentro do arquivo .stories, visto que na hora de gerar a build, esse arquivo é ignorado.

Tarefas automatizadas

Veja abaixo todas as tarefas automatizada utilizando npm NPM scripts.

Tarefas Descrição
npm run storybook Responsável por inicializar o projeto na porta 6006.
npm run build Responsável por fazer o next compilar a aplicação.
npm run prod Responsável por para testar a aplicação compilada pelo next, também inicializa o servidor na porta 3000
npm start Responsável por rodar a projeto após ele ter sido compilado pelo next.
npm run lint Responsável por verificar erros e padronizar o código.