Go to file
Addy Osmani ec60a75cba Add quick start information. 2014-05-23 20:02:58 +01:00
_samples Adds a cleaner version of samples 2014-05-08 18:59:06 +01:00
app Replace with app layout 2014-05-23 19:58:30 +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 code style tweaks, gulpfile improvements and remove unused deps 2014-05-16 10:18:34 +02:00
.jshintrc add meta files to enforce code style 2014-05-16 09:47:19 +02:00
LICENSE
README.md Add quick start information. 2014-05-23 20:02:58 +01:00
gulpfile.js Provide a sample hosted URL 2014-05-18 14:40:57 +01:00
package.json code style tweaks, gulpfile improvements and remove unused deps 2014-05-16 10:18:34 +02:00

README.md

Web Starter Kit

A starting point for multi-device development

Overview

Web Starter Kit is a starter kit 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 Central team and will include UX pattern samples and best practices that fall in line with some opinions we have about how multi-screen webapps should be built.

Quickstart

You can use Web Starter Kit just by cloning this repository and building on what we include in the app directory. If however you would like to use the optional tooling we provide:

# Run to install the dependencies needed (requires Node)
$ sudo 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

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.

Contains

  • Mobile-optimized HTML Boilerplate
  • Sexy mobile styles and 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