Best practices for modern web development
Clone or download
Permalink
Failed to load latest commit information.
.github Add guide on JS modules (#6272) Jun 18, 2018
gae New in Chrome 69 (#6576) Sep 4, 2018
gulp-tasks add documentation for contributors on using the helpful widget (#6663) Sep 26, 2018
src Podcast image fix (#6753) Oct 21, 2018
tools Adding in automatic translation support (#6745) Oct 19, 2018
.csslintrc Just file moves: Jan 5, 2015
.eslintrc Add Puppeteer to /web/tools/ (#5644) Jan 16, 2018
.gitignore New in Chrome 69 (#6576) Sep 4, 2018
.gitmodules Fixing the build Sep 9, 2015
.jscsrc Moves next-version into master Oct 12, 2016
.jshintrc Removing existing files, will add under old/ Jun 30, 2015
.travis.yml Always flush memcache after deployment Oct 16, 2018
CONTRIBUTING.md Update link to new styleguide in CONTRIBUTING (#4756) Jun 26, 2017
LICENSE Moves next-version into master Oct 12, 2016
README.md Update README.md (#5231) Oct 30, 2017
TRANSLATION.md Point to new translation guide Jul 6, 2016
app.yaml Desktop PWA refactor (#6731) Oct 16, 2018
appengine_config.py Moves next-version into master Oct 12, 2016
appengine_main.py Desktop PWA refactor (#6731) Oct 16, 2018
devsiteHelper.py Propose fix typo for occurred (#5757) Feb 8, 2018
devsiteIndex.py Improved template support (#5656) Jan 17, 2018
devsitePage.py Migrates Hacked guides into WebFu (#5233) Dec 22, 2017
devsiteParseHTML.py Font update & Code Highlighting (#6420) Jul 24, 2018
devsiteParseMD.py Font update & Code Highlighting (#6420) Jul 24, 2018
devsiteParseYAML.py Fixes variable check Sep 19, 2018
gcloud-client-secret.json.enc Migrate to Travis CI from Drone (#4143) Feb 6, 2017
gulpfile.js Makes building RSS/ATOM feeds optional (#6225) Jun 5, 2018
package.json Adding in automatic translation support (#6745) Oct 19, 2018
start-appengine.sh Move update-resources to start-appengine Feb 6, 2018

README.md

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

Start Local Server

To view the site locally, just run:

npm start

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