1.1.2 • Published 10 months ago

@pedidopago/ui-tiny v1.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Iniciar 🚀

Requisitos:

  1. Clone o Repositorio

    git clone git@github.com:pedidopago/pedidopago-ui.git 
  2. Instalar as dependencias:

    yarn

    Executar o projeto localmente:

    Iniciar o projeto com o storybook:

    yarn storybook

    Para executar os testes use o script:

    yarn test

    Para mais detalhes dos scripts considere consultar o package.json na raiz do projeto.

    📌 Ira precisar tambem das variaveis de ambiente CHROMATIC_PROJECT_TOKEN e SKIP_PREFLIGHT_CHECK.

Estrutura de codigo

Ao entrar no projeto sempre entre em packages/pedidopago-ui para trabalhar/executar os scripts

Roadmap 🌐

  • Mudar a estrutura de pastas

  • Sessão de novos componentes

  • Atualização de pacotes

  • Incrementação dos testes

  • Melhorias na documentação

  • Adicionar license

Contribuir 💡

  1. Crie uma branch apartir da dev com o prefixo lib-número da issue-nome da issue. exemplo:
 git checkout -b lib-99-buttom
  1. Desenvolver

  2. Criar a pull request

  • Número da issue no inicio da pr.
  • Descritivo com pontos importantes do que foi feito.
  • Print dos tests no terminal e video de apresentação que pode ser feito via loom.