{"id":22168741,"url":"https://github.com/celere-dev/web-vitals","last_synced_at":"2025-08-19T23:05:16.687Z","repository":{"id":261328125,"uuid":"882333899","full_name":"celere-dev/web-vitals","owner":"celere-dev","description":"🦕 Essential website metrics delivered by email","archived":false,"fork":false,"pushed_at":"2025-04-27T13:56:58.000Z","size":87,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-19T04:57:28.151Z","etag":null,"topics":["core-web-vitals","deno","github-actions","lighthouse"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/celere-dev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-02T14:50:09.000Z","updated_at":"2025-06-19T04:12:54.000Z","dependencies_parsed_at":"2024-11-06T00:28:47.785Z","dependency_job_id":"9db0c3d0-b5b8-40f1-9ad5-917d484bc521","html_url":"https://github.com/celere-dev/web-vitals","commit_stats":null,"previous_names":["celere-dev/celere-web-vitals","celere-dev/web-vitals"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/celere-dev/web-vitals","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celere-dev%2Fweb-vitals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celere-dev%2Fweb-vitals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celere-dev%2Fweb-vitals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celere-dev%2Fweb-vitals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/celere-dev","download_url":"https://codeload.github.com/celere-dev/web-vitals/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celere-dev%2Fweb-vitals/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271236280,"owners_count":24723978,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["core-web-vitals","deno","github-actions","lighthouse"],"created_at":"2024-12-02T06:25:05.443Z","updated_at":"2025-08-19T23:05:16.673Z","avatar_url":"https://github.com/celere-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"English (US) | [Português (BR)](./README.pt-BR.md)\n\n# Célere Web Vitals\n\n![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fcelere-dev%2Fcelere-web-vitals%2Factions%2Fworkflows%2F128475555%2Fruns%3Fstatus%3Dcompleted%26per_page%3D1\u0026query=%24.workflow_runs%5B0%5D.run_started_at\u0026style=flat-square\u0026label=last%20email%20sent\u0026color=%232f0b48\u0026link=https%3A%2F%2Fgithub.com%2Fcelere-dev%2Fcelere-web-vitals%2Factions)\n\nDeno-based application that generates a Lighthouse report and sends it as plain text via email using the Resend API through GitHub Actions.\n\nThe application evaluates Core Web Vitals in a customized manner, considering that no interactivity test is performed during report generation. It runs Lighthouse in its default navigation mode, simulating a user-free environment.\n\nThree metrics are used to calculate the Core Web Vitals: Largest Contentful Paint (LCP), Cumulative Layout Shift (CLS), and Total Blocking Time (TBT), which [replaces](https://web.dev/articles/inp#lab-measurement) Interaction to Next Paint (INP). Following Google’s methodology, if a website reaches the 75th percentile for each metric, it is labeled as \"passed\"; otherwise, it is marked as \"failed.\"\n\nThe following metrics are included in the report:\n\n- Core Web Vitals (LCP, CLS, TBT)\n- Largest Contentful Paint (LCP)\n- Cumulative Layout Shift (CLS)\n- First Contentful Paint (FCP)\n- Total Blocking Time (TBT)\n- Time to First Byte (TTFB)\n\nPerformance scores are also provided:\n\n- Performance\n- Accessibility\n- Best Practices\n- SEO\n\nAdditionally, the application supports:\n\n- Setting the text language. Currently available in English (`en`) and Brazilian Portuguese (`pt-BR`)\n- Analyzing multiple websites\n- Sending reports to multiple recipients\n- Configuring sender, recipients, websites, and language (locale) via environment variables\n\nLearn more about [Core Web Vitals](https://web.dev/explore/learn-core-web-vitals).\n\n## Usage\n\n### Requirement\n\n- [Resend](https://resend.com/) API Key\n\n### Setup\n\nTo use this workflow, you need to configure the following environment variables in GitHub Secrets:\n\n1. Clone or fork this repository.\n\n2. Add the secrets to your GitHub repository. Go to `Settings \u003e Secrets and variables \u003e Actions` and add the necessary secrets.\n\n    - `RESEND_API_KEY`: Your Resend API key.\n    - `RESEND_EMAIL_FROM`: The sender's email address.\n    - `RESEND_EMAIL_TO`: The recipient's email address.\n    - `URLS`: The URLs you want to monitor.\n    - `LOCALE`: The desired language for the report.\n\n    Use the [.example.env](.example.env) file as a reference.\n\n3. The workflow will run automatically with the configured cron job, or you can trigger it manually via `workflow_dispatch`. Use [crontab.guru](https://crontab.guru/) to edit the expression.\n\n    ```yaml\n    schedule:\n        - cron: \"0 11 * * 1\"\n    ```\n\n### Example of sent email\n\nSubject:\n```\nPerformance: 56 - CWV: failed - example.com\n```\n\nText:\n```\nURL: https://example.com\nCreated on: 11/22/2024, 18:53:13\n\n- Web Vitals -\nCore Web Vitals (CWV) [LCP, CLS, TBT]: failed\nLargest Contentful Paint (LCP): poor\nCumulative Layout Shift (CLS): needs improvements\nFirst Contentful Paint (FCP): needs improvements\nTotal Blocking Time (TBT): moderate\nTime to First Byte (TTFB): good\n\n- Scores -\nPerformance: 56\nAccessibility: 82\nBest Practices: 100\nSEO: 100\n\nThis report is generated in a simulated environment without a real user.\n```\n\n## Development\n\n### Requirements\n\n- Deno 2.0.6+\n- Google Chrome 131+\n- Resend API Key\n\n### Installation\n\n1. Clone the repository.\n\n    ```bash\n    git clone git@github.com:celere-dev/web-vitals.git\n    ```\n\n2. Configure the variables in a `.env` file located in the project root directory. Use the [.example.env](.example.env) file as a reference.\n\n    ```bash\n    cp .example.env .env\n    ```\n\n3. Install the dependencies.\n\n    ```bash\n    deno install\n    ```\n\n4. Run the task.\n\n    ```bash\n    deno task send\n    ```\n\n### Development note\n\nThe warning \"Not implemented: ClientRequest.options.createConnection\" usually indicates that you are attempting to use a Node.js feature not supported by Deno.\n\n## License\n\nThis project is licensed under the terms of the GNU General Public License v3.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelere-dev%2Fweb-vitals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcelere-dev%2Fweb-vitals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelere-dev%2Fweb-vitals/lists"}