Instalação

Crie, e customize os layouts de seus projetos de maneira simples e eficiente. Faça o upload de todos os seus arquivos de forma automática utilizando a nossa console tool.

A console tool nada mais é do que uma gem escrita em Ruby onde é possivel realizar download e upload dos arquivos do tema de uma forma mais dinâmica permitindo um ambiente de alta produtividade, por isso é a nossa recomendação.

pré requisito: Ruby - versão igual ou superior á 2.1.7

$ gem install opencode_theme
$ opencode systeminfo
Ruby: v2.3.3-p222
OpencodeTheme: v:1.0.5
Operating System: x86_64-linux
HTTParty: v0.14.0
Launchy: v2.4.3

Atualização

A atualização da Console Tool é recomendada para sempre manter compatível com os recursos do OpenCode.

Para esta atualização, é necessário verificar a versão da GEM utilizada, pois caso utilize uma versão igual ou inferior a versão 0.1.2, é necessário desinstalar a GEM e realizar uma nova instalação

$ gem update opencode_theme
$ opencode systeminfo
Ruby: v2.3.3-p222
OpencodeTheme: v:1.0.5
Operating System: x86_64-linux
HTTParty: v0.14.0
Launchy: v2.4.3

Desinstalação

Caso utilize uma versão igual ou inferior a versão 0.1.2 será necessário realizar a desinstalação da GEM e a instalação para versão atual.

$ gem uninstall opencode_theme

Comandos Disponiveis

Para saber quais comandos estão disponíveis digite o comando ao lado:

$ opencode -h
$ opencode new API_KEY PASSWORD THEME_NAME THEME_BASE
$ opencode clean
$ opencode configure API_KEY PASSWORD THEME_ID
$ opencode download FILE
$ opencode help [COMMAND]
$ opencode list
$ opencode open
$ opencode remove FILE
$ opencode systeminfo
$ opencode upload FILE
$ opencode watch

Chaves de desenvolvimento

As chaves API_KEY e PASSWORD necessarias para criação e manutenção de temas são geradas através do painel administrativo, na aba Minha Loja > Design Da Loja , no canto superior direito, como mostra abaixo.

Lista de Desenvolvedores

Criar Tema

Cria um novo tema com o nome informado.

É possivel também informar um tema base para criação informando também o id do tema a ser utilizado.

Experimente já!

Ficou curioso para saber como funciona? Experimente criar agora uma tema na nossa loja de teste…

Para isso basta usar a API_KEY e o PASSWORD disponibilizados a baixo:

API_KEY: 20a699301d454509691f3ea02c1cba4b
PASSWORD: ea0727075e1639a42fd966a2f6e67abc

o comando ficará da seguinte maneira:

$ opencode new 20a699301d454509691f3ea02c1cba4b  ea0727075e1639a42fd966a2f6e67abc "primeiro-tema"

Após isso o seu tema já estará criado.

ATENÇÃO, não crie nenhum tema importante com as credenciais a cima. Por se tratar de uma loja de teste todos os temas criados são apagados periodicamente.

 $ opencode new API_KEY PASSWORD THEME_NAME THEME_BASE

Cache no Tema

Esse comando é responsável por limpar o cache dos arquivos estáticos do tema.

$ opencode clean

Configurar tema para edição

Esse comando é responsável por configurar o tema, é através dele que é gerado o arquivo config.yml, responsável pela sincronização do tema.

$ mkdir meuTema
$ cd meuTema
$ opencode configure API_KEY PASSWORD THEME_ID 
  ---
  :api_key: API_KEY
  :password: PASSWORD
  :theme_id: THEME_ID
  :preview_url: PREVIEW_URL

Download dos arquivos do Tema

Esse comando é responsavel por efetuar o download dos arquivos, ou de um arquivo especifico do tema.

$  opencode download FILE 

Help de comandos

Esse comando é responsavel por descrever um comando especifico.

$  opencode help COMMAND 

Temas disponiveis

Esse comando é responsavel por listar todos os temas da loja.

$    opencode list 

Preview do Tema

Esse comando é responsavel por abrir a loja no navegador

$    opencode open 

Excluir arquivos

Esse comando é responsavel por remover um arquivo do tema (apenas se o tema não estiver publicado)

$    opencode remove FILE 

Detalhes de Instalação

Esse comando é responsavel por mostra informações do sistema

$    opencode systeminfo 

Upload de Arquivos

Esse comando é responsavel por fazer upload dos arquivo informado ou todos se FILE for omitido

$    opencode upload FILE 

Upload automatico de arquivos

Esse comando é responsavel por monitorar os arquivo sempre que ele for salvo

$    opencode watch 

Erros

Abaixo descrição dos possiveis erros exibidos na gem

Código Descrição
00313 Extensão ou nome de arquivo invalido, verifique as regras aqui.
00314 Não é permitido o envio de arquivos para este diretórios veja a estrutura do tema aqui.
00401 Não é possivel editar o tema já publicado, saiba mais aqui