sdk-react's Introduction
sdk-react's People
sdk-react's Issues
Initial Issue
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
- Criar uma cobrança utilizando uma função, que retorna um objeto com os dados da cobrança.
- Disponibilizar um componente já pronto para ser utilizado, que recebe os dados da cobrança e renderiza o Link de pagamento da Woovi.
- 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 )
- Garantir que a SDK seja compatível com o React 16.0+
- Garantir 100% de cobertura de testes em todos os componentes e fluxos
- Criar uma documentação clara e objetiva, com exemplos práticos de como utilizar a SDK
- Fornecer tipagem de todos os componentes e funções da SDK
- Utilizar o JSDoc para documentar as funções e componentes de forma mais detalhada
- Criar um Storybook para visualização dos componentes e funções da SDK
- Criar um playground para testar a SDK de forma mais prática e online.
- Disponibilizar a SDK via NPM e Yarn
- Criar um sistema de versionamento semântico para a SDK
- Automatizar o processo de publicação da SDK no NPM e Yarn
Passos para serem seguidos antes de iniciar o projeto
- Configuração do ambiente de desenvolvimento (Yarn, GitHub etc.)
- Configuração do TypeScript (o tsconfig.json será configurado usando o da Woovi.)
- Configuração do ESLint (o eslint será configurando os padrões da Woovi)
- Configuração do Prettier ( o prettier será configurado usando os padrões da Woovi)
- Configuração do Vitest (o vitest será configurado usando os padrões da Woovi)
- Configuração do Storybook
- Configuração do Husky
- Configuração do Lint-Staged
- Criação dos pacotes no NPM e Yarn
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.