Design System

:mag_right: Índice

1. Contexto
2. Estrutura do repositório
3. Rodando em produção
4. Instruções para instalação e acesso ao projeto
5. Contribua
6. Licença

:rocket: Contexto

O Design System da Impulso Gov apresenta os padrões de interface que devem ser seguidos por designers e desenvolvedores para garantir a experiência única na interação com os sistemas interativos da Impulso Gov.

A iniciativa potencializa a eficiência e a eficácia dos usuários na utilização de interfaces para acesso aos serviços e aos sistemas da Impulso, possibilitando uma única curva de aprendizado e garantindo a previsibilidade na utilização dos diferentes sistemas.

:milky_way: Estrutura do repositório

root
├─ .storybook
├─ componentes
├─ docs

• componentes: componentes para serem consumidos pelas aplicações da ImpulsoGov
• .storybook: arquivos de confuguração do storybook
• docs: páginas de documentação no storybook

:gear: Rodando em produção

As nossas aplicações são rodadas na vercel.

🛠️ Instruções para instalação e acesso ao projeto

Instale pela linha de comando:

yarn add @impulsogov/designsystem

Execução em ambiente local

yarn sb

Execução em produção

yarn start

Build componentes

yarn build

Build aplicação storybook

yarn build-storybook

Versionamento

O design-system segue as praticas de versionamento semantico e adota as seguintes convenções:

Patch

• Alterações de componentes sem mudanças nas propriedades (Mantém retro-compatibilidade)

Minor

• Adiciona novos compomentes

Major

• Mudanças estruturais, como mudança de tecnologia, ferramentas, estrutura de diretório e retro-compatibilidade.

Documentação

A documentação foi implementada com o storybook, nela você encontra:

• lista de componentes disponiveis
• pre-visualização
• exemplo de consumo
• descrição e orientações das propriedades de cada componente
• fundamentos visuais :
  • paleta de cores
  • tipografia
  • espaçamentos
  • logos

Publicação

• Publicar pacote apenas a partir da branch main.

:left_speech_bubble: Contribua

Sinta-se à vontade para contribuir em nosso projeto! Abra uma issue ou envie PRs.

:registered: Licença

MIT (c) 2020, 2022 Impulso Gov [email protected]