`master` staging: https://web-central.appspot.com/web/

<hr>

Web Fundamentals is a technical documentation center for multi-device web

development. Our goal is to build a resource for modern web developers

that’s as curated and thorough as developer.android.com or iOS Dev Center.

To build and run this project you need to have Ruby, Node and NPM.

1. Install [XCode Command Line Tools](https://developer.apple.com/xcode/downloads/)

1. Install node

* [https://nodejs.org/en/](https://nodejs.org/en/)

1. Install [RVM](https://rvm.io/rubies/default)

* `curl -sSL https://get.rvm.io | bash`

1. Set RVM Default to 2.2.0

* `rvm install ruby-2.2.0`

* `rvm --default use 2.2.0`

1. Install [Pygments](http://pygments.org/)

* `easy_install pygments`

1. Install bundler

* `gem install bundler`

1. Install [RubyGems](https://rubygems.org/) dependencies ([Jekyll](http://jekyllrb.com/) and [Kramdown](http://kramdown.gettalong.org/))

* `rvm . do bundle install`

1. Install the [Gulp CLI](http://gulpjs.com/)

* `npm install -g gulp`

1. Install [npm](https://www.npmjs.org) dependencies

* `npm install`

1. Get the [App Engine SDK for Python](https://cloud.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python) and unzip into the google_appengine folder inside the project root. Add it to your path accordingly (in bash, `$ PATH=./google_appengine:$PATH`)

To run the site:

gulp

This will compile styles & javascript and build the site with Jekyll. If thats

all working, it will start a server on port 7331 (which you can reach at

[http://localhost:7331/web/fundamentals](http://localhost:7331/web/fundamentals)).

Any changes to files will result in the appropriate tasks be running in gulp.

To make the build faster you can define a language and/or section of the site

be built.

If you want to build a single language then run this:

gulp --lang en

If you want to build a specific section then run this:

gulp --section shows

These can be combined like so:

gulp --lang en --section shows

We have a resource area which you can access at [https://web-central.appspot.com/web/resources/?hl=en](https://web-central.appspot.com/web/resources/?hl=en) that should get you up and running with a lot of the custom and useful info.

**Note: this feature is experimental.**

The build process automatically creates staging sites for all pull requests.

To access the staging site for a pull request:

1. Open the pull request on `github.com`.

2. Click **Show All Checks**.

3. Click **Details** next to the **Builder** check. The staging site opens

up in a new tab.

You can also access each staging site directly, using the following URL:

https://pr-<NUMBER>-dot-weasel-dot-web-central.appspot.com

Where `<NUMBER>` is the pull request number. For example, the URL for

PR #1000 would be:

https://pr-1000-dot-weasel-dot-web-central.appspot.com

Staged branches are also available at:

<branch>-dot-weasel-dot-web-central.appspot.com

Where `<branch>` is the name of the branch.

**The URL pattern for pull requests and branches may change without notice.**

See [our translations guide](https://developers.google.com/web/resources/translations/)

You need the python [Google API client](https://developers.google.com/api-client-library/python/start/installation)

For Linux:

pip install --upgrade google-api-python-client

Content plan for Web Fundamentals is tracked through GitHub Issues and our [Site Structure + Content Inventory](http://goo.gl/nWDD0M) doc

The project was soft launched in late April with a formal v1 launch in June 2014. We've now moved to a six-week rolling release cycle.

This is a Jekyll build.

The site is generated in `/build`, which is never checked in.

Web Fundamentals is an open source project and we welcome your contributions!

Before submitting a pull request, please review [CONTRIBUTING.md](CONTRIBUTING.md)

and make sure that there is an issue filed describing the fix or new content.

If you don't complete these steps, we won't be able to accept your pull request, sorry.