README

Biblioteca para auxiliar no pontapé inicial em um projeto web. A idéia foi juntar alguns dos projetos que mais utilizávamos como referência e adaptarmos para um modelo de desenvolvimento com um Guia de Estilo incluso. Entenda a idéia aqui.

Requisitos

NodeJS - (para poder instalar as bibliotecas usando o npm)
Gulp - (para rodar as tarefas de pré-processador: CSS/JS/IMAGENS entre outras)
Ruby/SASS - (para poder usar a biblioteca gulp-ruby-sass)
Bower - (para poder instalar os componente: font-awesome/jquery/respond/normalize.css entre outros)

Instalação

Começando

Existem algumas opções disponíveis:

Faça o download do zip ou do último release
Clone o projeto git clone https://github.com/snack/snack.git

Boilerplate

Para instalar as bibliotecas do Gulp: npm install

Para instalar todas as dependências: bower install

Para rodas as tarefas de inicialização do projeto usando Gulp: gulp

Para sincronizar a página em diversos dispositivos usar: gulp sync

*Lembrar de alterar no Gulpfile.js o proxy, para a url do seu projeto local, para poder funcionar o gulp sync.

gulp.task('browser-sync', function() {
    browserSync.init({
        proxy: "local.snack"
    });
});

Styleguide

O styleguide utiliza o AngularJs para montar os templates de cada componente.

Documentação

Muita coisa? 😖 Dá uma olhada na documentação completa. Fica dentro da pasta doc na raiz do projeto.

Atualização

Esse é um projeto em constante atualização. Pode ser que algo apresentado aqui não se adeque ao seu workflow. Fique a vontade para abrir uma issue e vamos discuti-la. 🤘

Suporte

Foi testado em diversos navegadores, mas como queremos que a web não pare no tempo, recomendamos você seguir a lista abaixo:

IE8+
Firefox 2+
Chrome 4+
Safari 3.1+
Opera 15

snack / snack

Maintainers

Details