Design System PEA Pescarte
Implementa e expõe componentes para a plataforma PEA Pescarte, conforme o Deisgn System do projeto no Figma.
Ambiente de Desenvolvimento local
Requisitos | versão |
---|---|
nodejs | v18.14.2 |
Caso você tenha Nix instalado, este repositório fornecesse um flake nix para criar um shell personalizado o qual já inclui a dependência nodejs
.
Basta executar, dentro do repositório:
nix develop
Caso tenha Nix e direnv instalados, basta executar:
direnv allow
Dentro do repositório para ter acesso ao shell com as dependências!
Executando pela primeira vez
Recupere as depências do projeto com:
npm install
Para conferir e visualizar os componentes localmente (storybook):
npm run storybook
Para executar os testes automatizados, execute:
npm run test
Caso queria formatar e analisar a estrutra do código:
npm run format-lint
Gostaria de contribuir com o projeto?
Leia nosso documento de guia para contribuição