marinatrajk/docs

The AMP Project Website.

amp.dev

The official homepage of the AMP Project.

Contributing

We welcome contributons to amp.dev.

• Bug reports and feature requests: something missing or not working on https://amp.dev? Please file an issue here.
• Documentation & Guides: see this guide for more information on how to contribute documentation to amp.dev.
• Code samples & demos: see this guide for more information on how to contribute sample code to amp.dev.

Note: fixing spelling mistakes and other small changes are often easiest by directly editing a file on Github.

Setup

Requirements

1. Install the LTS version of NodeJS. An easy way to do so is with nvm. (Mac and Linux: here, Windows: here)

   $ nvm install --lts

2. Install Grow the static site generator used to build amp.dev:

   $ curl https://install.grow.io | bash

3. Install the dependencies for the project:

   $ npm install

Develop

If it's your first time working on amp.dev it is recommended to bootstrap your local environment. To do so make sure you have setup a valid GitHub access token in an environment variable named AMP_DOC_TOKEN like:

$ export AMP_DOC_TOKEN="c59f6..."

This enables the import from GitHub to run flawlessly which can be started by the following command which additionally will build the Playground and Boilerplate Generator once:

$ gulp bootstrap

You can then start developing in your local environment with the command below. The task will take care of building and copying all files, watching them for changes and rebuild them when needed. Beware that changes to the express.js backend require to restart the task.

$ gulp develop

This command prints a lot to the shell and will most probably end on Server ready. Press ctrl-c to quit.. This means everything went fine so far but other than stated in the logs the site is then available at http://localhost:8080/. The service running on 8081 is only Grow rendering the pages.

Maintenance

Documents

Made changes to a lot of Grow documents at once and not quite sure if all references are still valid? You can run npm run lint:grow to pick up broken ones.

Samples

Building the samples creates a lot of individual files per sample. In order to still have a quick startup time for development only changed samples are rebuilt. To freshly build all samples you can run gulp develop --clean-samples.

Run a test build

To run a local test build that does all the minifying and vends the static pages instead of proxying them through to Grow you can run

$ gulp build --env local
$ npm run start:local

Build

Caution: starting a build automatically cleans all locations of possible remainings from previous builds. Make sure you don't have anything there that you want to keep - additionally check your working copy for eventual unintended local changes.

To perform a build run the following command with --env being one of the following valid environments: development, local, staging or production:

$ gulp build --env <environment>

This builds all parts of the project and might take a while. Usually all builds on amp-dev-staging.appspot.com and amp.dev are built using Travis CI. In case you want to reproduce one of those remote builds in your local environment you can fetch the build artifacts by running:

$ gulp fetchArtifacts --travis-build <build_number>

---

Copyright 2019 The AMP HTML Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.