Skip to content

cwdoh/WebFundamentals

This branch is 1 commit ahead of, 1081 commits behind google/WebFundamentals:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

May 5, 2019
1e2c80d · May 5, 2019
Jun 18, 2018
Feb 26, 2019
May 1, 2019
May 5, 2019
Apr 25, 2019
Jan 5, 2015
Jan 16, 2018
Jan 29, 2019
Sep 9, 2015
Oct 12, 2016
Jun 30, 2015
Oct 30, 2018
Oct 30, 2018
Jun 26, 2017
Oct 12, 2016
Nov 1, 2018
Jul 6, 2016
Oct 23, 2018
Oct 12, 2016
Oct 16, 2018
Feb 8, 2018
Jan 17, 2018
Dec 22, 2017
Jul 24, 2018
Jul 24, 2018
Sep 19, 2018
Feb 6, 2017
Jun 5, 2018
May 1, 2019
Feb 6, 2018

Repository files navigation

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 Node 10 or greater, 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

Note: The first time you start the server, you may need to run start-appengine.sh and answer any prompts provided by dev_appserver.py.

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

About

Best practices for modern web development

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 63.1%
  • CSS 16.1%
  • Liquid 7.2%
  • Ruby 4.9%
  • PHP 4.5%
  • JavaScript 3.4%
  • Other 0.8%