google/WebFundamentals


Best practices for modern web development

https://developers.google.com/web/fundamentals

License: Apache-2.0

Language: HTML

Keywords: best-practices, chrome, chrome-browser, css, html, html5, javascript, mobile-web, progressive-web-app, web, web-app


Web Fundamentals on DevSite

Build Status

Welcome to the new WebFundamentals! An effort to showcase best practices and tools for modern Web Development.

What's changed?

  • We're now using the DevSite infrastructure
    • New style guide
    • New widgets allow inline JavaScript, common links, related guide and more
  • Jekyll has been eliminated, instead pages are rendered at request time
  • Front-matter has been eliminated from the markdown, but files now require a simple set of tags

What stays the same?

Cloning the repo

If you have a high bandwidth connection, I recommend starting with a fresh clone of the repo.

git clone https://github.com/google/WebFundamentals.git

Getting set up

The new DevSite infrastructure simplifies the dependencies a lot. Ensure you have a recent version of Node and the AppEngine SDK for Python already installed.

  1. Run npm install (needed for the build process)

Build the auto-generated files

Some files (contributors includes, some pages for updates, showcases, etc) are automatically generated. The first time you clone the repo and run npm install, this is done for you. However, when you add a case study, update, etc., you'll need to re-build those files using:

npm run build

Update the code labs

To update the Code Labs, you'll need the claat tool, and access to the original Doc files. This will likely only work for Googlers.

  1. Download the claat tool and place it in your tools directory.
  2. Run tools/update-codelabs.sh
  3. Check the latest changes into GitHub

Start the development server

  1. Run npm start

Test your changes before submitting a PR

Please run your changes through npm test before submitting a PR. The test looks for things that may cause issues with DevSite and tries to keep our content consistent. It's part of the deployment process, so PRs will fail if there are any errors! To run:

npm test

Project Statistics

Sourcerank 9
Repository Size 1.53 GB
Stars 10,171
Forks 2,066
Watchers 587
Open issues 611
Dependencies 26
Contributors 97
Tags 6
Created
Last updated
Last pushed

Top Contributors See all

Paul Kinlan Pete LePage Meggin Kearney Pedro Duarte Matt Gaunt Paul Bakaus Ian Barber Antoine Grélard andyhawkes Joe Medley Sam Dutton dgash Sam Chen Ilya Grigorik Jacopo Notarstefano Paul Lewis Mat Scales Kayce Basques Chang W. Doh Joshua Appelman

Recent Tags See all

20161111-1952 November 11, 2016
20161111-1918 November 11, 2016
20161110-1749 November 11, 2016
0.3 October 04, 2016
0.1 October 29, 2015
0.2 August 14, 2015

Interesting Forks See all

paulirish/WebFundamentals
Best practices for modern web development
HTML - Apache-2.0 - Updated - 12 stars - 1 forks
jakearchibald/WebFundamentals
Best practices for modern web development
HTML - Apache-2.0 - Last pushed - 7 stars - 3 forks
paullewis/WebFundamentals
Best practices for modern web development
HTML - Last pushed - 4 stars
robdodson/WebFundamentals
Best practices for modern web development
HTML - Apache-2.0 - Updated - 4 stars
tarobjtu/WebFundamentals
Best practices for modern web development
CSS - Apache-2.0 - Last pushed - 4 stars - 4 forks

Something wrong with this page? Make a suggestion

Last synced: 2017-11-24 18:51:53 UTC

Login to resync this repository