crgeary / pickle

Extend the shelf life of PageSpeed Insights reports 🥒

Pickle

Extend the shelf life of PageSpeed Insights reports 🥒

---

PageSpeed Insights is a fantastic tool for gathering a quick overview of common page performance issues. Simply provide a URL and within seconds you have a report of actionable recommendations and key performance metrics.

Unfortunately, those reports cannot be shared, downloaded or accessed in the future. This is where Pickle comes in. Pickle is a wrapper around the PageSpeed Insights API which automatically stores reports, and makes them available & shareable for years to come.

Roadmap

• Handler for GET /pagespeedonline/v5/runPagespeed
• Handler for GET /audits/{id}
• Handler for GET /audits
• Handler for POST /audits

Usage

Pickle aims to replicate the same API request & response of PageSpeed Insights. It then further extends it to provide additional information and access to historical reports.

Method	Route	Description
GET	/pagespeedonline/v5/runPagespeed	Runs PageSpeed analysis on the specified URL
GET	/audits	Query for existing PageSpeed reports
POST	/audits	Runs PageSpeed analysis on the specified URL
GET	/audits/{id}	Retrieve an existing PageSpeed report by it's ID

The POST /audits route is an alias of the original GET /pagespeedonline/v5/runPagespeed route, but it provides a more REST like API.

Architecture

Pickle is built for AWS. The architecture is roughly as described below. For a more in detailed description of the architecture, check out the cloudformation template.

Deploying

You will need an S3 bucket to store deployment artifacts. You can create one with:

aws s3 mb s3://{bucket_name}

Then use that bucket name to deploy with:

ARTIFACT_BUCKET={bucket_name} ./scripts/deploy.sh

Licence

MIT