Skip to content

Redirecione os tráfego dos assets de lojas VTEX para ter controle local e fazer alterações sem impactar o ambiente de produção, para lojas que utlizam estrutura CMS.

License

Notifications You must be signed in to change notification settings

Trivod/trv-vtex-proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 

Repository files navigation

Trv Proxy for VTEX

🇧🇷 (PT-BR)

Redirecione os tráfego dos assets de lojas VTEX para ter controle local e fazer alterações sem impactar o ambiente de produção, para lojas que utlizam estrutura CMS.

Imagens, arquivos de CSS e JS, entre outros.

Este projeto é indicado para equipes de desenvolvimento, QA, suporte, ou quem tiver interesse em realizar testes sem atualizar nada no ambiente produtivo antes de ter certeza que tudo está como esperado. Ele executa em modo terminal, linha de comando, e não está disponível a versão de interface gráfica nele.

Note: Indique a funcionalidade dos seus sonhos. Veja o item notas

image

Para ter acesso na sua loja, veja o tópico Notas

A aplicação levanta um servidor HTTPS e busca arquivos dentro pasta local e caso não encontre um arquivo, ele deixa o fluxo padrão seguir e busca o arquivo remoto.

Estrutura de diretórios

Neste momento server HTTPS está mapeando a pasta as seguintes pastas locais (leia-se diretórios, path na URL).

  • /dist/arquivos
  • /dist/files
  • /dist/customElements
  • /dist/htmltemplates
  • /dist/partials
  • /dist/subtemplates

Todas as pastas acima são mapeadas para o ambiente local. E ao utilizar o endereço local, será verificado se o arquivo solicitado está dentro de uma destas pastas. Caso não exista, o proxy realizará a chamada diretamente ao domínio da loja VTEX. Caso este arquivo também não exista online, o retorno comum da plataforma VTEX será entregue na requisição.

Obs: Este projeto não possui render dos componentes Vtex. Em breve novidades por aqui 😎.

Disponível para as plataformas:

Como utilizar:

  1. Baixe o utilitário referente ao seu S.O em um dos links acima
  2. Coloque o arquivo na raiz do projeto
  3. Rode o utilirário com o comando abaixo:
./TrivodProxy-macos -f ./config.json -p 433

É possível rodar o utilitário sem o passar o arquivo de configuração como parâmetro. Dessa forma, ele busca a chave vtex dentro do package.json. Apenas crie a estrutura conforme o exemplo de configuração mais abaixo.

O parâmetro -f ./config.json (pode ser qualquer nome) indica o arquivo de configuração que deve possuir a chave vtex com o atributo store para ativar baseado no nome da loja.

O parâmetro -p 443 indica a porta para o servidor HTTP

Após a execução, será impresso no terminal a URL local do projeto.

É indicado que você utilize essa URL mapeada em seu arquivo hosts caso necessário, para que seja possível uma melhor experiência com a navegação.

127.0.0.1  {id-loja-vtex}.vtexlocal.com.br

Exemplo de arquivo de configuração

{
    "vtex": {
        "store": "vtex-store-name-id",
      }
}

FAQ

URL Insegura

Sim, neste momento, ainda, o SSL está self-signed para o ambiente disponível pelo proxy. É necessário adicionar o certificado como válido para continuar a navegação.

Para Linux

Pode ser necessário configurar o aplicativo para que seja possível executálo com as permissões necessários como:

chmod +x TrivodProxy-linux.

Notas

Neste momento o proxy está em modo fixo para algumas lojas. Para que seja possível utilizar na sua loja, envie um email para suporte+trvproxy@trivod.com com o título "acesso ao trv-vtex-proxy" e indique no corpo do e-mail o nome da loja Vtex a qual você deseja utilizar no trv-vtex-proxy.

Em breve estaremos postando novidades relacionadas a novas funcionalidades, incluindo estrutura para qualquer tipo de projeto e não apenas Vtex. Ative o modo observador aqui do projeto para acompanhar novas versões publicadas.

Caso queira indicar ou solicitar funcionalidades extras, fique a vontade para abrir uma Issue e descrever sua necessidade ou ideia para o projeto, ou também pode enviar por email para suporte+trvproxy@trivod.com.

About

Redirecione os tráfego dos assets de lojas VTEX para ter controle local e fazer alterações sem impactar o ambiente de produção, para lojas que utlizam estrutura CMS.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •