Tableless

Busca Menu

Google Web Starter Kit

Seja o primeiro a comentar por

Organizar pastas, incluir suas bibliotecas favoritas de JavaScript, ressetar o CSS, escrever as primeiras linhas de HTML… Estas tarefas se repetem a cada projeto de desenvolvimento front-end. Ter uma base sólida e organizada como ponto de partida pode poupar muito tempo precioso de trabalho…

Acredito que cada um tem o seu próprio kit inicial a sua maneira. A galera mais old school mantém uma pastinha na área de trabalho e copia e cola os itens a cada utilização, os mais moderninhos tem repositórios super completos com todo tipo de recurso. Seja qual for o seu estilo de organização, sempre bate uma curiosidade para ver (e aprender com) o setup de outros profissionais. Iniciativas para criar projetos colaborativos nesta linha não são exatamente inéditas. O HTML5 Boilerplate, por exemplo, está aí para provar. E faz um bom trabalho em ser um ponto de partida quase minimalista para projetos web. Temos lá um HTML base bacaninha, o Normalize, snippets úteis e até mesmo alguns recursos de imagens pré-prontos como favicons e touch icons.

Mas e se a gente for um passo além? E incluir alguns truques extras na manga como automatizadores, guias de estilos, sincronização multi-dispositivo e otimização de performance? Foi isto que a galera do Web Fundamentals fez ao criar o Google Web Starter Kit. Vamos explorar com ele funciona!

web-starter-kit

O que ele NÃO é

Antes de iniciarmos é importante ressaltar que o Web Starter Kit não é um Framework. A ideia não é construir uma biblioteca de elementos pré-prontos como é o caso do Bootstrap e do Foundation. O Web Starter Kit é um chute inicial, uma base para que você possa criar e editar os seus próprios componentes, sem ficar preso em padrões engessados de layout.

Um pequeno aviso

Até a data de publicação deste artigo o Web Starter Kit ainda estava em fase Beta. Ou seja, muita coisa pode mudar até a versão final. (Mas quem quer esperar até lá, não é mesmo?) De qualquer forma, para fins de comparação, este artigo se baseia na versão 0.4.0 do kit.

Inícios

O primeiro passo, obviamente, é baixar os arquivos. Você pode fazer isto através do site oficial clicando no botão gigante “Download Kit” ou clonar o repositório no GitHub. A partir daí temos duas opções. Você pode ficar apenas com o boilerplate e ser feliz com ele. Neste caso delete os arquivos package.json, gulpfile.js, .jshintrc e .travis.yml e, bem, pare de ler este artigo pois não tenho nenhuma outra dica pra você. Mas, se você quiser conhecer as ferramentas extras continue comigo que vou explicar melhor os paranauês.

Ferramentas

Boilerplate responsivo

Um arquivo HTML e um CSS inicial para servir de base para os seus projetos. O HTML inclui diversas meta-tags e alguns snippets úteis pré-prontos como Google Analytics, por exemplo. Esta parte é bem parecida com o HTML5 Boilerplate. É tudo o que os nossos amigos que pararam de ler no parágrafo de cima ganharam.

web-starter-kit-home

Guia de Estilos

Um Guia de Estilos bacana para documentar os componentes do seu sistema. É bem organizado com tipografia, cores, botões, grids,  tabelas, etc. (Não sabe pra que cazzo serve um Guia de Estilos? Eu escrevi um artigo inteirinho sobre este tema e fiz até uma Palestra Online a respeito. Vai lá ler que eu te espero aqui).

Reload ao vivo do browser

Chega de apertar F5 que nem um louco, amigo! Edite o documento e assista seu browser recarregar em tempo real. Outra maravilha da humanidade.

Sincronização multi-dispositivo

Coloque todos os seus dispositivos em cima da mesa e certifique que todos estão na mesma rede local, acesse um IP e observe maravilhado os navegadores sincronizando simultaneamente cliques, scrolls, formulários, reload, etc. Uma coisa linda. Isto é extremamente útil para assustar os colegas de outros departamentos falando “o meu tablet está se mexendo sozinho”. E também para testar design responsivo como se não houvesse amanhã. Eu particularmente não entendo como eu vivia antes de conhecer isto. Ah, o live reload também funciona neste caso.

Otimização de Performance

Minificação de JS, CSS, HTML e Imagens em uma ferramenta só. Você também pode consultar relátorios do Page Speed Insights.

Suporte a SASS

Compilação sem esforço.

Estrutura de Pastas

Ao baixar os arquivos você recebe isto aqui:

web-starter-kit-pastas

Pode parecer um pouco óbvio para quem não é mais iniciante, mas vamos dar uma olhada em arquivo por arquivo.

  • readme – uma versão resumida da documentação oficial;
  • license – informações sobre licença (Apache 2.0);
  • package.json – metadados e dependências do projeto;
  • gulpfile.js – arquivo de automatização;
  • pasta app – sua pasta de produção.

 

Vamos dar uma olhadinha mais de perto na pasta app:

  • apple-touch-icon-precomposed.png e favicon.ico – ícones de favoritos;
  • humans.txt – informações sobre a equipe de produção do projeto (ou seja, VOCÊ);
  • robots.txt – configuração para robôs de busca;
  • manifest.webapp – metadados do projeto;
  • pasta fonts – arquivos de fontes a serem importadas via @font-face;
  • pasta images – arquivos de imagens;
  • pasta scripts – arquivos JavaScript;
  • pasta styles – arquivos de CSS e SCSS;
  • pasta styleguide – arquivos do Guia de Estilos;

 

Nós também temos dois arquivos HTML. A ideia é que você escolha qual deles prefere utilizar (e delete o outro).

  • basic.html – HTML zero bala para você iniciar seu projeto;
  • index.html – HTML com um menu responsivo off-canvas pré-pronto.

 

Na pasta styles temos o seguinte:

  • h5bp.css – o CSS base do HTML5 Boilerplate com algumas normatizações;
  • main.css – folha de estilos principal;
  • pasta components – os módulos de CSS propriamente ditos. Se quiser adicionar ou remover arquivos basta editar o arquivo components.scss

 

Bem, agora que você já conhece cada uma das ferramentas e a estrutura de pastas vamos ao passo-a-passo para fazer tudo isto funcionar.

Requisitos

Vamos precisar de Node, Ruby, Sass e Gulp. Se você já tiver estes componentes pode pular esta etapa. Se não vamos instalar juntos passo-a-passo.

Um parágrafo de consolo para quem tem medo do terminal

Esta parte do artigo envolve um conhecimento obscuro: saber utilizar linhas de comando. A maior parte dos devs tiram de letra mas, tem gente que tem receio ou verdadeiro pavor daquela telinha preta do Terminal ou do Prompt de Comando (se você for usuário de Windows)! Mas é bem tranquilo. Prometo. Galera, eu sou designer, amo interfaces gráficas e consegui. Vai lá e pega um cafezinho, respira fundo e não entre em pânico.

Comandos básicos

cd

O primeiro comando que você precisa saber hoje é “cd”. Este comando abre o diretório que você determinar. Então basicamente você vai digitar cd e o caminho de pasta. No caso do OSX é só escrever cd e arrastar e soltar uma pasta que o terminal já preenche com o caminho completo.

-v ou –version

Serve para você descobrir a versão de um componente instalado. Por exemplo node -v retorna qual é a versão do Node.js. Se aparecer uma mensagem de erro é por que você provavelmente não tem este componente instalado.

sudo

Pode acontecer de você não ter permissão do sistema para realizar uma determinada ação no terminal. Mas você pode obter uma permissão temporária de super usuário (ou super user do… entendeu?). Ou seja, se um determinado comando não funcionar, tente repetir a mesma coisa digitando sudo antes.

Instalando as ferramentas

1. Node.js

Para quem não conhece, o Node é uma plataforma para desenvolver aplicações server-side escaláveis utilizando JavaScript. Você pode checar se ele existe na sua máquina digitando o seguinte comando no terminal ou cmd.

node -v
Se o terminal retornar “v0.10” ou superior

Ótimo! Siga para o passo 2.

Se o arquivo não for encontrado

Você vai precisar instalar. Visite o nodeJS.org e clique no botão gigante verde. É só baixar o instalador, clicar em próximo, próximo, próximo e ser feliz. Sem segredos até aqui.

2. Ruby

Também vamos precisar de Ruby Gems para gerenciar pacotes. Se você utiliza Mac ele vem pré-instalado. De qualquer forma descubra se você possui / qual é a sua versão:

ruby -v
Se o terminal retornar “v1.8.8” ou superior

Ótimo! Siga para o passo 3.

Se o arquivo não for encontrado

Visite www.ruby-lang.org/downloads e siga as instruções. Opcionalmente você pode utilizar o Ruby Installer  se estiver no Windows.

3. SASS

O SASS vai pré-processar o nosso CSS para utilizarmos diversas funções legais como variáveis, mixins, cálculos matemáticos, etc. Vá em frente e digite:

sass -v
Se o terminal retornar “v3.3” ou superior

Ótimo! Siga para o passo 4.

Se o arquivo não for encontrado

É possível instalar o SASS pelo próprio terminal. Basta digitar:

gem install sass

Se não funcionou é provável que você não tenha permissão de pastas necessárias. Neste caso você pode utilizar o comando sudo.

sudo gem install sass

Agora é só checar a versão e seguir para o próximo passo:

sass -v

Se você tiver qualquer dificuldade pode visitar também o site oficial do SASS e baixar um instalador.

4. Gulp

O Gulp é um automatizador de tarefas. Verifique se ele já existe:

Gulp -v
Se o terminal retornar “v3.5” ou superior

Ótimo! Siga para o passo 5.

Se o arquivo não for encontrado

É possível instalar o Gulp pelo próprio terminal. Basta digitar:

npm install --global gulp

Se obter um erro tente novamente utilizando “sudo”.

sudo npm install --global gulp

5. Dependências locais

Instale as dependências locais do Web Starter Kit da seguinte maneira:

cd web-starter-kit
npm install

Prontinho. Agora você tem tudo o que precisa para começar a trabalhar!

Comandos do Gulp

Agora é a parte divertida. Use estes comandos para realizar as tarefas de automação do Gulp.

Rotina de Automatização

gulp

O comando gulp serve para executar a rotina prevista no arquivo gulpfile.js. Se esta é a primeira vez que você roda você vai notar a criação da pasta “Dist”. É aqui que vão ficar os arquivos finais do projeto, prontos para você subir onde quiser.

As outras tarefas da rotina são: verificação de erros no JavaScript, otimização de imagens, prefixação automática de CSS, compilação do SASS, minificação de HTML, CSS e JS, copia dos arquivos finais para a pasta Dist e reload do browser. Você pode retirar as ações que não quiser ou acrescentar novos comandos editando o arquivo gulpfile.js.

Servidor local

gulp serve

Roda a rotina de automação do Gulp e gera um endereço de IP. Basta acessar este endereço através de navegadores de dispositivos que estão na sua rede local. Agora você pode testar o seu projeto sincronizadamente e todos os navegadores vão ser recarregados automaticamente a cada mudança nos arquivos.

(Se quiser parar o processo basta usar o atalho Control + C).

Relatório de Velocidade

gulp pagespeed

Através deste comando você obtém um relatório completo, utilizando a API do Google Pagespeed Insights.

web-starter-kit-pagespeed

Outros comandos

Você pode ler uma lista completa de comandos disponível na documentação oficial.

Veja tudo funcionando

Vamos apenas fazer uma pequena modificação nos arquivos para verificar se está tudo ok. Use o gulp serve no terminal dentro da pasta app.

cd web-starter-kit
gulp serve

Agora abra o arquivo index.html no seu editor favorito (eu sou fã do Sublime, mas fique a vontade). Vamos trocar o este título aqui:

<h1>Hello.</h1>

Por algo mais brasuca.

<h1>Olá mundo!</h1>

Salve e assita a magia acontecer. Agora o meu trabalho termina e o seu começa. Boa diversão!

Suporte

O Web Starter Kit foi criado para funcionar bem nos seguintes navegadores:

  • IE9, IE10, IE11, IE Mobile 10
  • FF 30, 31
  • Chrome 34, 35
  • Safari 7, 8
  • Opera 23, 24
  • iOS Safari 7, 8
  • Opera Coast
  • Android / Chrome 4.4, 4.4.3
  • BlackBerry 10

Isto não significa que o kit não funciona em browsers mais antigos. É só que eles não são exatamente o foco da ferramenta.

Desconstrua!

A intenção deste artigo é demonstrar uma possibilidade de configuração inicial. Mas lembre-se que este tipo de kit deve ser usado como uma bussula, não como uma muleta! Copie o repositório, explore os códigos e comentários dos arquivos e aprenda com eles. Estude o que eles oferecem de bacana, delete o que não for. Acha grids fixos uma porcaria (e eu sou a primeira a levantar a mão neste caso)? Use um grid semântico. Não curte pré-processadores? Vá em frente e use CSS baunilha. Renomeie os assets como quiser. Ou jogue tudo fora e construa o seu do zero. O bacana de boilerplates é que (cof cof… diferentemente de frameworks… cof cof) eles não te prendem a um estilo específico de design ou códigos legados gigantes. Enfim, faça uma engenharia reversa e construa o seu próprio kit de ferramentas. E não se esqueça de compartilhar as ideias boas com a gente depois… Até a próxima!

Publicado no dia