A collection of AMP tools making it easier to publish and host AMP pages.
Switch branches/tags
Nothing to show
Clone or download
sebastianbenz Merge pull request #149 from ampproject/logging
Improve Debugging & Configuation
Latest commit beec905 Nov 13, 2018

README.md

AMP Toolbox

Build Status

A collection of AMP tools making it easier to publish and host AMP pages. The following tools are part of this project:

Development

Setting up your environment

After forking amp-toolbox to your own github org, do the following steps to get started:

# clone your fork to your local machine
git clone https://github.com/your-fork/amp-toolbox.git

# step into local repo
cd amp-toolbox

# install dependencies via https://lernajs.io/
npx lerna bootstrap --hoist

Adding new dependencies

amp-toolbox uses Lerna to manage it's packages. To keep build times low, devDependencies must be added to the root package.json file. Runtime dependencies are managed for each package individually.

Running Tests

The test suite runs for all packages and must be run from the root directory.

# run tests on node and browser
npm test

# run only in node (fastest)
npm run test:node

# run only in browser
npm run test:browser

Style & Linting

This codebase adheres to the Googe Javascript Styleguide and is enforced using ESLint. ESLint is run as part of the test suite, but you can also explicity run it via:

# run ESLint
npm run lint

# run ESLint with `--fix` option to automatically fix errors (if possible)
npm run lint:fix

Contributing

Please see the CONTRIBUTING file for information on contributing to the AMP Project.

License

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