Go to file

Stephen Sawchuk f22738e3ba sync readme `gulp watch` => `gulp serve`		2014-06-19 07:45:12 -04:00
app	formatty things.	2014-06-19 07:42:22 -04: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	Add CC block to end of license file 1/2	2014-06-13 15:07:19 +01:00
README.md	sync readme `gulp watch` => `gulp serve`	2014-06-19 07:45:12 -04:00
gulpfile.js	formatty things.	2014-06-19 07:42:22 -04:00
package.json	Fixes for style guide image paths, style guide component linking.	2014-06-19 12:21:01 +01:00

README.md

Google Web Starter Kit

A starting point for multi-device web 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.js build tooling (optional)
- LiveReload
- Cross-device synchronization of clicks, scrolls, navigation, and form-filling
- Image optimization
- JavaScript minification and optimization
- CSS optimization
- HTML minification
- PageSpeed performance reporting
- CSS autoprefixing

Quickstart

Download the kit or clone this repository and build on what we include in the app directory.

We provide 3 HTML starting points, from which you can choose:

index.html - the default starting point, containing a slide-out menu,
alt-layout.html - features a horizontal navigation menu, or
basic.html - includes no layout.

Tooling

If you would like to use the optional tooling we provide, make sure your system has Node, Ruby, Gulp and the Sass gem installed.

Node

Let's check to see if you already have Node installed. Bring up a terminal and type node -v. If Node responds, and if it shows a version at or above v0.10.x, proceed to checking if you have Ruby installed too. If you require Node, go to NodeJS.org and click on the big green Install button.

Ruby

Bring up a terminal and type ruby -v. If Ruby responds, and if it shows a version number at or above 1.8.7 then type gem --version. If you don't see any errors, proceed to installing the Sass gem. If you require Ruby, it can be installed from the Ruby downloads page.

Sass gem

Bring up a terminal and type sass -v. If Sass is installed it should return a version number at or above 3.3.x. If you don't see any errors, proceed to the Gulp installation. If you need to install Sass, see the command-line instructions on the Sass installation page.

Gulp

Bring up a terminal and type gulp -v. If Gulp is installed it should return a version number at or above 3.5.x. If you don't see any errors, proceed to the Gulp commands section. If you need to install Gulp, open up a terminal and type in the following:

$ npm install --global gulp

This will install Gulp globally. Depending on your user account, you may need to gain elevated permissions using sudo (i.e sudo npm install --global gulp). Next, install the local dependencies Web Starter Kit requires:

$ npm install

That's it! You should now have everything needed to use the Gulp tools in Web Starter Kit.

Gulp commands

You can now use Gulp with the following commands to stay productive during development:

# Watch files / LiveReload / Cross-device sync as you develop
$ gulp serve

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

# Build the current project, ready for deployment. This includes image, script,
# stylesheet and HTML optimization and minification.
$ gulp

Web Performance

Web Starter Kit strives to give you a high performance starting point out of the box and we actively work on delivering the best PageSpeed Insights score and frame-rate possible.

Browser Support

At present, we officially aim to support the following browsers:

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 1.0

This is not to say that Web Starter Kit cannot be used in browsers older than those reflected, but merely that our focus will be on ensuring our layouts work great in the above.

Troubleshooting

If you find yourself running into issues during installation or running the tools, please check our Troubleshooting guide and then open an issue. We would be happy to discuss how they can be solved.

Inspiration

Web Starter Kit is inspired by Mobile HTML5 Boilerplate and Yeoman's generator-gulp-webapp, having taken input from contributors to both projects during development.

Contributing

Contributions, questions and comments are all welcome and encouraged. For code contributions, please see our Contribution guide before submitting a patch.