LogoLogo
Documentação de Temas
Documentação de Temas
  • 🚀COMECE POR AQUI
    • Temas Tray
    • Entenda o Tema
    • Meu primeiro tema
  • 💻Tray CLI
    • Instalação
    • Comandos
      • Erros Retornados
    • API para integrações Tray CLI
  • 🧱Construindo seu Template
    • Twig
      • O que é o Twig
      • Como ele é utilizado nos temas
      • Possibilidades de uso
      • Documentação para consulta
    • Visão Geral
      • Estrutura do Tema
      • Arquivo de configuração
      • Extensões de arquivos
      • Codificação de Arquivos
      • Avisos e Recomendações
      • Flags
    • Editor do Tema
      • Antigo
        • Como criar um Editor
        • Settings.html
      • Novo
        • Estrutura
          • Seções
          • Ícones
          • Componentes
            • Text
            • Textarea
            • Email
            • Number
            • Color
            • Checkbox
            • Radio
            • Select
            • Toggle
            • Upload
            • Tab
            • Alert
          • Exemplo de utilização
        • Thumb preview do tema
        • Imagens padrões
        • Como desabilitar e reabilitar?
      • Settings.json
    • Desenvolver
      • Atributo Google Analytics 4
      • Como adicionar o botão comprar na listagem dos produtos
      • Como criar um carrossel de produtos
      • Como inserir um vídeo na home da loja
      • Como manipular as variações de produtos
      • Como saber se o usuário está logado
      • Descontinuação do carrinho.php
      • Exibindo as formas de pagamento de um produto
      • Informação de preço com tempo de cache menor
      • Order Bump - Produtos Relacionados
      • Páginas Institucionais
      • Página de recuperação de senha
      • Página Live Shop
      • Recursos extras
      • Personalização das paginas de carrinho e checkout
    • Core Web Vitals
      • Desempenho
        • Lazyload
        • Primeira dobra
        • Fontes
        • Definição largura e altura
        • Sprite formas de pagamentos
      • Boas Práticas
        • Origem cruzada
      • Acessibilidade
        • Atributo Lang
        • Nome discernível
        • Atributo ALT
        • Contraste
        • IDs únicos
        • ARIA Labelled By
        • Tabindex
    • Otimizar e Medir
      • Carregamento na home
      • Layout AMP
      • Utilizando PWA na loja
    • Referências
      • Objetos
        • banner
        • breadcrumb
        • category
        • categories
        • filters
        • filter_options
        • links
        • pages
        • paginate
        • paymentMethods
        • product
        • productTabs
        • products
        • productFeatured
        • seals
        • search
        • settings
        • store
        • tags
        • tray
        • themePath
        • utils
      • Funções
        • asset()
        • Brands()
        • Categories()
        • Image()
        • Products()
        • Translation()
      • Data Attributes
        • Banners
        • Cart
        • Compare
        • Filter
        • Logged User
        • Search (Suggestion)
      • Componentes
        • Adicionar ao carrinho sem sair da página
        • Banner Desconto Progressivo
        • Banner extra com contagem de cliques
        • Banner Régua
        • Banner Rotativo
        • Botão "Voltar para o topo"
        • Botões Quantidade
        • Carrinho Lateral
        • Exibir a segunda imagem ao passar o mouse
        • Filtro Inteligente
        • Link flutuante para Whatsapp
        • Menu de Categorias
        • Menu de Categorias em 3 Níveis
        • Menu de Categorias com ver mais categorias
        • Menu de Categorias com Imagens
        • Menu de Categorias com Imagens - Hover
        • Menu de Categorias com produto
        • Menu de Marcas
        • Modal de Ofertas
        • Notícias com imagem na home
        • Novo Filtro Inteligente
        • Paginação
        • Porcentagem Desconto
        • Popup de Newsletter
        • Star Ranking
        • Selos da Loja
        • Selos do produto
        • Showcase ( List / Grid )
        • Topo Flutuante
        • Tray Login
        • Whatsapp flutuante
    • APIs Disponíveis
      • Busca
      • Carrinho de Compra
      • Categorias
      • Produtos
      • Variações de Produto
  • ✔️Homologação
    • Loja de Temas Tray
    • Requerimentos
      • Exclusividade
      • Identidade única
      • Estrutura necessária
      • Funcionalidades
      • Nova Busca e Filtro inteligente
      • Selos de produtos
      • Google Lighthouse
      • Consistência e funcionalidade
      • Compatibilidade com navegadores
      • Assets
      • Otimização para buscadores (SEO)
      • Acessibilidade
      • Configurações
      • Sistema de cores
      • Imagens responsivas
      • Nomes dos temas
      • Versionamento e notas de lançamento
      • Lojas demonstrativas
      • Documentação e suporte
    • Checklist obrigatório
    • Templates
    • Homologando o tema
    • Atualizando o tema
    • FAQ
  • 📣NOVIDADES
    • Tray CLI
    • Checklist
    • Tema Draft
    • Novo Editor
Powered by GitBook
On this page
  • O que você vai aprender
  • Antes de começar
  • Passo 1: Instale o Tray CLI
  • Passo 2: Gere as chaves
  • Passo 3: Crie um novo tema
  • Passo 4: Personalize o layout do tema

Was this helpful?

  1. COMECE POR AQUI

Meu primeiro tema

Você está pronto para criar um novo tema e está se perguntando como configurar rapidamente seu ambiente de desenvolvimento e começar a codificar? Neste tutorial, te mostrarei o que você precisa!

PreviousEntenda o TemaNextInstalação

Last updated 1 year ago

Was this helpful?

O que você vai aprender

Depois de terminar este tutorial, você conseguirá realizar o seguinte:

  • Configurar seu ambiente de desenvolvimento local

  • Criar um novo tema sincronizado entre o seu ambiente de desenvolvimento e a plataforma.

  • Personalizar o seu tema com o Tray CLI em execução no terminal

Antes de começar

Antes de começar a desenvolver temas, faça o seguinte:

  • Para obter uma loja de desenvolvimento e criar um tema, você precisará se tornar um Parceiro Tray, começando pelo preenchimento do formulário no site:

  • Com o cadastro aprovado crie sua loja na plataforma.

  • Depois entre em contato com o suporte a parceiros para que eles desabilitem o faturamento da loja e ela não seja bloqueada por falta de pagamento.

Atenção: Essa loja não poderá receber pedidos reais. Caso isso aconteça, ela será desabilitada.

Passo 1: Instale o Tray CLI

Para desenvolver nossos temas e fazer a conexão da nossa plataforma com seu ambiente de desenvolvimento você precisará utilizar nossa interface de linha de comando disponibilizada.

O nome dessa interface é o Tray CLI, para saber mais sobre como instala-la e utilizá-la acesse o link abaixo:

Passo 2: Gere as chaves

1. Faça o login no painel administrativo pela URL da sua loja.

2. Acesse a aba Minha Loja > Design Da Loja ou Minha Loja > Aparência da Loja (de acordo com o painel da sua loja)

3. Acesse a Lista de desenvolvedores

4. Clique em Incluir Desenvolvedor

5. Insira um Nome da agencia e E-mail, depois clique em Salvar que a chave de acesso será gerada automaticamente.

6. Copie o código exibido para Key e Password elas são importantes para sincronizar o seu ambiente de desenvolvimento com a plataforma. Salve elas em um arquivo de fácil acesso que a utilizaremos nos próximos passos.

Passo 3: Crie um novo tema

  1. No seu computador de desenvolvimento crie uma nova pasta para o tema que será desenvolvido.

2. Na pasta abra o terminal para utilizar o Tray CLI

Recomendamos o uso do Visual Studio Code com o terminal Bash instalado, devido a facilidade de manuseio do mesmo para o desenvolvimento.

3. Digite o comando para criar um novo tema baseado do tema padrão da Tray com as chaves de acesso geradas e o Nome do tema que preferir da seguinte forma:

tray create [options] [key] [password] [theme-name] [theme-base]

Quando o comando for concluído, na pasta do seu computador será gerado um arquivo config.yml com as informações necessárias para sincronizar seu ambiente, e na plataforma um novo tema será exibido com o nome que foi definido por você no comando.

Passo 4: Personalize o layout do tema

Com a pasta no seu computador configurado, você precisará baixar o tema Padrão criado na plataforma para começar a editá-lo.

  1. Na pasta do tema abra o terminal e use o comando tray download para baixar todos os arquivos do tema da plataforma para o seu computador, da seguinte forma:

tray download

Após conclusão do download siga para os próximos passos.

2. Para começar a personalizar o tema e as alterações serem enviadas automaticamente para a plataforma, no terminal utilize o comando tray watch, da seguinte forma:

tray watch

Para parar a execução do comando no terminal utilize as teclas CTRL + C.

Atenção

Arquivos SASS / SCSS não são mais suportados.

3. Para visualizar as modificações aplicadas na loja utilize o comando tray open, da seguinte forma:

tray open

Para mais informações sobre o uso do comando acesse o link: .

O arquivo config.yml só existirá no seu computador, para que ele faça a conexão do seu ambiente de desenvolvimento com a plataforma. Não modifique este arquivo para não prejudicar o funcionamento do Tray CLI. Saiba mais no link: .

Para mais informações sobre o uso do comando acesse o link: .

🚀
Quero ser Parceiro
Instalação
Arquivo de configuração
download
download