Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ampproject/amp-toolbox
A collection of AMP tools making it easier to publish and host AMP pages.
https://github.com/ampproject/amp-toolbox
amp amp-html amp-toolbox
Last synced: 9 days ago
JSON representation
A collection of AMP tools making it easier to publish and host AMP pages.
- Host: GitHub
- URL: https://github.com/ampproject/amp-toolbox
- Owner: ampproject
- License: apache-2.0
- Created: 2017-12-08T13:57:07.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T17:29:09.000Z (3 months ago)
- Last Synced: 2024-10-30T04:11:23.694Z (21 days ago)
- Topics: amp, amp-html, amp-toolbox
- Language: HTML
- Homepage:
- Size: 28.6 MB
- Stars: 449
- Watchers: 43
- Forks: 243
- Open Issues: 90
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-amp - AMP Toolbox - A collection of AMP tools making it easier to publish and host AMP pages. (Development and Optimization)
README
# AMP Toolbox
A collection of AMP tools making it easier to publish and host AMP pages. The following tools are part of this project:
- **[amp-cache-url](/packages/cache-url):** a javascript library for translating origin URLs to the [AMP Cache URL format](https://developers.google.com/amp/cache/overview).
- **[amp-cache-list](/packages/cache-list):** a javascript library for listing the known AMP Caches.
- **[amp-cli](/packages/cli):** a command line version of AMP Toolbox
- **[amp-cors](/packages/cors):** a connect/express middleware to automatically add [AMP Cors headers](https://www.ampproject.org/docs/fundamentals/amp-cors-requests).
- **[amp-linter](/packages/linter):** a javascript library for linting AMP documents (includes CLI mode).
- **[amp-optimizer](/packages/optimizer):** a javascript library implementing server-side-rendering for AMP pages.
- **[amp-optimizer-express](/packages/optimizer-express)** an [express](http://expressjs.com/) middleware that applies AMP server-side-rendering on the fly.
- **[amp-optimizer-docker](/packages/optimizer-docker)** a [Docker](http://docker.com) container that exposes an API for AMP server-side-rendering on the fly.
- **[amp-runtime-fetch](/packages/runtime-fetch):** a javascript library for downloading the AMP runtime.
- **[amp-runtime-version](/packages/runtime-version):** a javascript library for querying the current AMP runtime version.
- **[amp-script-csp](/packages/script-csp):** a javascript library for calculating [`amp-script`](https://amp.dev/documentation/components/amp-script/) compatible CSP hashes.
- **[amp-update-cache](/packages/update-cache):** a javascript library for updating AMP documents in AMP Caches.
- **[amp-validator-rules](/packages/validator-rules):** a javascript library for querying AMP validator rules.
## 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
npm install
# run tests
npm test
```
### Adding new dependencies
amp-toolbox uses [Lerna](https://lerna.js.org/) to manage it's packages. To keep build times low, `devDependencies` ([but not CLI dependencies](https://github.com/lerna/lerna/issues/1079#issuecomment-337660289)) must be added to the root [package.json](/package.json) file. Runtime dependencies are managed for each package individually.
When adding a new package inside the `packages` directory, register the package via:
```
npm run bootstrap
```
### 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
```
Using additional arguments the node tests can generate a coverage report or run only for a specific package.
```
# generate a coverage report
npm run test:node -- --collectCoverage
# run only tests for AMP Optimizer
npm run test:node -- packages/optimizer
```
### Style & Linting
This codebase adheres to the [Google Javascript Styleguide](https://google.github.io/styleguide/jsguide.html) 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
```
### Making a Release
Before publishing a release, make sure to have the lates changes from master and the changelog is up-to-date:
```
$ npm run changelog
```
This will print all changes since the previous release. For this to work, all PRs need to be [correctly labeled](https://github.com/lerna/lerna-changelog#usage) as:
- `breaking` (💥 Breaking Change)
- `enhancement` (🚀 Enhancement)
- `bug` (🐛 Bug Fix)
- `documentation` (📝 Documentation)
- `internal` (🏠 Internal)
Copy and prepend the new changes to [CHANGELOG.md](/CHANGELOG.md) when you're about to make a release. Don't forget to update the version. Commit the updated changelog and run:
```
$ npm publish
```
to publish all changed packages to NPM. Pick the new version according to [SemVer](https://semver.org/).
## Contributing
Please see [the CONTRIBUTING file](/CONTRIBUTING.md) for information on contributing to the AMP Project.
## License
AMP Toolbox is made by the [AMP Project](https://www.ampproject.org/), and is licensed under the [Apache License, Version 2.0](/LICENSE).