https://github.com/crgeary/pickle
Extend the shelf life of PageSpeed Insights reports 🥒
https://github.com/crgeary/pickle
aws javascript pagespeed-insights web-performance
Last synced: about 1 year ago
JSON representation
Extend the shelf life of PageSpeed Insights reports 🥒
- Host: GitHub
- URL: https://github.com/crgeary/pickle
- Owner: crgeary
- License: mit
- Created: 2021-06-21T17:03:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-17T10:48:22.000Z (almost 5 years ago)
- Last Synced: 2025-03-29T01:11:10.478Z (about 1 year ago)
- Topics: aws, javascript, pagespeed-insights, web-performance
- Language: JavaScript
- Homepage:
- Size: 1.03 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
- [x] Handler for `GET /pagespeedonline/v5/runPagespeed`
- [x] 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](https://developers.google.com/speed/docs/insights/v5/reference/). 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](./infrastructure/main.yml).
## Deploying
You will need an S3 bucket to store deployment artifacts. You can create one with:
```sh
aws s3 mb s3://{bucket_name}
```
Then use that bucket name to deploy with:
```sh
ARTIFACT_BUCKET={bucket_name} ./scripts/deploy.sh
```
## Licence
[MIT](./LICENSE)