{"id":19515165,"url":"https://github.com/crgeary/pickle","last_synced_at":"2025-04-15T20:39:27.400Z","repository":{"id":48621767,"uuid":"379004597","full_name":"crgeary/pickle","owner":"crgeary","description":"Extend the shelf life of PageSpeed Insights reports 🥒","archived":false,"fork":false,"pushed_at":"2021-07-17T10:48:22.000Z","size":1075,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T01:11:10.478Z","etag":null,"topics":["aws","javascript","pagespeed-insights","web-performance"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crgeary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-21T17:03:01.000Z","updated_at":"2024-03-28T19:39:19.000Z","dependencies_parsed_at":"2022-09-11T11:12:02.876Z","dependency_job_id":null,"html_url":"https://github.com/crgeary/pickle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crgeary%2Fpickle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crgeary%2Fpickle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crgeary%2Fpickle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crgeary%2Fpickle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crgeary","download_url":"https://codeload.github.com/crgeary/pickle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249149937,"owners_count":21220831,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","javascript","pagespeed-insights","web-performance"],"created_at":"2024-11-10T23:38:48.111Z","updated_at":"2025-04-15T20:39:27.371Z","avatar_url":"https://github.com/crgeary.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pickle\n\nExtend the shelf life of PageSpeed Insights reports 🥒\n\n---\n\nPageSpeed 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.\n\nUnfortunately, 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 \u0026 shareable for years to come.\n\n## Roadmap\n\n-   [x] Handler for `GET /pagespeedonline/v5/runPagespeed`\n-   [x] Handler for `GET /audits/{id}`\n-   [ ] Handler for `GET /audits`\n-   [ ] Handler for `POST /audits`\n\n## Usage\n\nPickle aims to replicate the same API request \u0026 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.\n\n| Method | Route                              | Description                                      |\n| ------ | ---------------------------------- | ------------------------------------------------ |\n| GET    | `/pagespeedonline/v5/runPagespeed` | Runs PageSpeed analysis on the specified URL     |\n| GET    | `/audits`                          | Query for existing PageSpeed reports             |\n| POST   | `/audits`                          | Runs PageSpeed analysis on the specified URL     |\n| GET    | `/audits/{id}`                     | Retrieve an existing PageSpeed report by it's ID |\n\nThe `POST /audits` route is an alias of the original `GET /pagespeedonline/v5/runPagespeed` route, but it provides a more REST like API.\n\n## Architecture\n\nPickle 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).\n\n![Architecture of AWS services: API Gateway, Lambda, S3 \u0026 DynamoDB](./resources/architecture.png)\n\n## Deploying\n\nYou will need an S3 bucket to store deployment artifacts. You can create one with:\n\n```sh\naws s3 mb s3://{bucket_name}\n```\n\nThen use that bucket name to deploy with:\n\n```sh\nARTIFACT_BUCKET={bucket_name} ./scripts/deploy.sh\n```\n\n## Licence\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrgeary%2Fpickle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrgeary%2Fpickle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrgeary%2Fpickle/lists"}