/ampstart

Primary LanguageHTMLApache License 2.0Apache-2.0

AMP Start

A collection of quick-start templates to build your AMP page quickly and easily. AMP Start is built on top of Basscss a low-level CSS toolkit.

Workspace Setup

Installation

  1. Install NodeJS.
  2. In the repo directory, run npm i command to install the required npm packages.
  3. Run npm i -g gulp command to install gulp system-wide (on Mac or Linux you may need to prefix this with sudo, depending on how Node was installed).

Build & Test

Command Description
gulp build[1] Builds the AMP library.
gulp clean Removes build output.
gulp www Recompile www to build directory.
gulp highlight Build HTML for code highlighting.
gulp watch[1] Watches for changes in files, re-build.
gulp serve Serves content in repo root dir over http://localhost:8000/.

[1] On Windows, this command must be run as administrator.

Deploying AMP on Cloud for testing on devices

For deploying and testing local AMP builds on Firebase, please follow the steps outlined in this page. Note that the firebase configuration is already created in the project.

Repository Layout

Directory Description
components/ CSS and HTML snippets (Mustache) for AMP Start components.
build/ (generated) intermediate generated files.
css/ CSS assets.
css/ampstart-base CSS Base AMP Start elements like buttons.
css/templates CSS for AMP Start templates.
css/www CSS for www.ampstart.com.
dist/ (generated).
hl-partials/ Partials that help generate copy pastable html for www.ampstart.com/components.html.
img/ Image assets.
tasks/ Gulp tasks.
templates/ AMP Start template HTML.
www/ www.ampstart.com

Supported browsers

In general we support the 2 latest versions of major browsers like Chrome, Firefox, Edge, Safari and Opera. We support desktop, phone, tablet and the web view version of these respective browsers.

Beyond that, the core AMP library and builtin elements should aim for very wide browser support and we accept fixes for all browsers with market share greater than 1 percent.

In particular, we try to maintain "it might not be perfect but isn't broken" - support for the Android 4.0 system browser and Chrome 28+ on phones.

Who makes AMP Start?

AMP Start is made by the AMP Project, and is licensed under the Apache License, Version 2.0.

Code of conduct