Visão geral | Como instalar | Como instalar em VTEX IO | Padrões de código |
Este sistema utiliza a API do Via Cep para buscar dados sobre um número de CEP inserido.
- Necessário ter no mínimo o node
14.x
- Baixe ou clone este repositório
- Acesse a pasta baixada e instale as dependências com
npm install
ouyarn install
- Rode o comando
yarn start
Para utilizar um serviço parecido com este dentro de uma loja VTEX IO devemos fazer o seguinte:
Dentro deste arquivo devemos declarar o bloco com o componente que iremos utilizar.
Exemplo:
"nike-pdp": {
"component": "NikePDP"
}
Devemos criar o arquivo NikePDP dentro da pasta react.
O caminho ficaria: react/NikePDP.tsx
Exemplo:
import NikePDP from "./components/NikePDP";
export default NikePDP;
Dentro da pasta NikePDP iremos colocar os códigos deste app.
Agora podemos utilizar o "snippet" nike-pdp
em qualquer parte da loja VTEX IO.
Ao utilizar o snippet este aplicativo será renderizado.
Para commits e branchs estamos utilizando o Conventional Commits que é composto por três partes.
- Tipo (type) - Obrigatório
- Escopo (scope) - Opcional
- Assunto (subject) - Obrigatório
Exemplos:
Problema que resolve | Mensagem de commit |
---|---|
Criar novo slider | feat: create new slider |
Corrigir bug no product summary | fix: bug in product summary |
Refatorar código do slider da homepage | refactor: homepage slider |
As branchs devem ser descritas de acordo com o problema que resolve.
Exemplos:
Problema que resolve | Nome da Branch |
---|---|
Criar novo slider | feat/create-new-slider |
Corrigir bug no product summary | fix/bug-product-summary |
Refatorar código do slider da homepage | refactor/homepage-slider |
Feito com 💗 por Patrick Gratão