Go to file

Sindre Sorhus f13e23bd16 gulpfile - no longer needs to change cwd it was fixed upstream: https://github.com/tkellen/node-liftoff/issues/16 Just `npm install -g gulp` to update.		2014-06-09 15:02:39 +02:00
app	Merge pull request #44 from yeoman/input	2014-06-09 13:56:40 +01:00
.editorconfig	add meta files to enforce code style	2014-05-16 09:47:19 +02:00
.gitattributes	add meta files to enforce code style	2014-05-16 09:47:19 +02:00
.gitignore	Ignore any .tmp files	2014-05-28 11:56:11 +01:00
.jshintrc	add meta files to enforce code style	2014-05-16 09:47:19 +02:00
LICENSE	Update license to Apache 2.	2014-06-05 15:24:21 +01:00
README.md	readme - add license mention	2014-06-06 14:06:29 +02:00
gulpfile.js	gulpfile - no longer needs to change cwd	2014-06-09 15:02:39 +02:00
package.json	Bump to latest version of PSI	2014-06-09 10:09:41 +01:00

README.md

Web Starter Kit

A starting point for multi-device development

Overview

Web Starter Kit is a starting point for multi-screen web development, encompassing opinionated recommendations on boilerplate and tooling for building an experience that works great across multiple devices.

The project aims to align with the mobile web recommendations made by Google's Web Fundamentals and includes boilerplate, tooling and best practices that fall in line with how we think multi-screen webapps should be built.

Features

Mobile-optimized HTML Boilerplate
Sexy minimalist layout
Visual component style guide
Gulp build tooling (Optional)
- LiveReload
- Cross-device synchronization of clicks, scrolls, navigation, form filling.
- Image optimization
- JavaScript minification and optimization
- CSS optimization
- PageSpeed integration

Quickstart

You can use Web Starter Kit just by cloning this repository and building on what we include in the app directory. You will want to checkout index.html (the default starting point, slide-out menu), 'alt-layout.html' (if you prefer a horizontal nav) or basic.html (no layout).

If you would like to use the optional tooling we provide:

# Install the gulp globally so you can run it in the terminal. Only need to to this once.
$ npm install --global gulp

# Install the local dependencies from package.json (requires Node)
$ npm install 

# Build the current project
$ gulp

# Watch files / LiveReload / Cross-device sync
$ gulp watch

# Run the deployed version of your app against PageSpeed
$ gulp pagespeed

Requirements

In addition to requiring Node, Ruby and the Sass gem are also required.

What performance requirements does Web Starter Kit have?

Web Starter Kit will be striving to ship with a 60fps experience and a PageSpeed score of 100 out of the box.

We intend to give developers a high performance starting point for multi-device development, paying close attention to this requirement when deciding on the libraries and tools we prescribe. We will be employing use of PageSpeed Insights and the Chromium Telemetry tools for helping us stay on top of this.

Inspiration

Web Starter Kit is inspired by Mobile HTML5 Boilerplate and Yeoman's generator-gulp-webapp.