Initial Issue

[edumaciel10]

Plano de Desenvolvimento da SDK React da Woovi/OpenPix

O principal foco dessa nova SDK React é disponibilizar para os clientes um ambiente de desenvolvimento mais amigável e intuitivo, com uma documentação e tipagem direta no código, facilitando a integração e manutenção do código, padronizando como os desenvolvedores irão interagir com a Woovi/OpenPix e garantindo que a integração seja feita de forma correta e segura.

Principais funcionalidades

1. Criar uma cobrança utilizando uma função, que retorna um objeto com os dados da cobrança.
2. Disponibilizar um componente já pronto para ser utilizado, que recebe os dados da cobrança e renderiza o Link de pagamento da Woovi.
3. Abstrair a lógica de Callback via Javascript, para que o desenvolvedor possa receber as informações da cobrança de forma mais simples via função anônima no React e atualizar a cobrança do lado dele de forma fácil. ( Pooling )
4. Garantir que a SDK seja compatível com o React 16.0+
5. Garantir 100% de cobertura de testes em todos os componentes e fluxos
6. Criar uma documentação clara e objetiva, com exemplos práticos de como utilizar a SDK
7. Fornecer tipagem de todos os componentes e funções da SDK
8. Utilizar o JSDoc para documentar as funções e componentes de forma mais detalhada
9. Criar um Storybook para visualização dos componentes e funções da SDK
10. Criar um playground para testar a SDK de forma mais prática e online.
11. Disponibilizar a SDK via NPM e Yarn
12. Criar um sistema de versionamento semântico para a SDK
13. Automatizar o processo de publicação da SDK no NPM e Yarn

Passos para serem seguidos antes de iniciar o projeto

1. Configuração do ambiente de desenvolvimento (Yarn, GitHub etc.)
2. Configuração do TypeScript (o tsconfig.json será configurado usando o da Woovi.)
3. Configuração do ESLint (o eslint será configurando os padrões da Woovi)
4. Configuração do Prettier ( o prettier será configurado usando os padrões da Woovi)
5. Configuração do Vitest (o vitest será configurado usando os padrões da Woovi)
6. Configuração do Storybook
7. Configuração do Husky
8. Configuração do Lint-Staged
9. Criação dos pacotes no NPM e Yarn