{"id":24953279,"url":"https://github.com/webengage/we-web-performance","last_synced_at":"2025-09-04T20:33:42.036Z","repository":{"id":274610328,"uuid":"923473054","full_name":"WebEngage/we-web-performance","owner":"WebEngage","description":"Web Performance Measuring Tool","archived":false,"fork":false,"pushed_at":"2025-01-28T10:49:57.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-28T11:24:37.497Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebEngage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-01-28T10:05:40.000Z","updated_at":"2025-01-28T10:50:00.000Z","dependencies_parsed_at":"2025-01-28T11:24:40.309Z","dependency_job_id":"e361d8b6-c5ff-4343-ad46-b5dcb636eacd","html_url":"https://github.com/WebEngage/we-web-performance","commit_stats":null,"previous_names":["webengage/we-web-performance"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fwe-web-performance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fwe-web-performance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fwe-web-performance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fwe-web-performance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebEngage","download_url":"https://codeload.github.com/WebEngage/we-web-performance/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246093096,"owners_count":20722395,"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":[],"created_at":"2025-02-03T03:33:01.182Z","updated_at":"2025-03-28T19:45:38.884Z","avatar_url":"https://github.com/WebEngage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web Metrics Measuring Tool\n\nThis repository dedicated to measuring and analyzing web performance metrics using [Puppeteer](https://pptr.dev/), a powerful Node.js library for controlling headless Chrome browsers.\n\n## Overview\n\nThis project leverages Puppeteer to collect critical performance metrics, enabling developers to monitor and improve the speed, responsiveness, and overall performance of their web applications.\n\n## Features\n\n- **Web Metrics Collection**: Measure key performance metrics such as First Contentful Paint (FCP), Largest Contentful Paint (LCP), and more.\n- **Automated Testing**: Automate performance testing of web pages using Puppeteer.\n- **Customizable Scripts**: Easily adapt and extend scripts to suit your specific needs.\n\n## Getting Started\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/) installed on your system.\n\n### Installation\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/WebEngage/we-web-performance.git\n   cd we-web-performance\n\n2. **Install Dependencies**:\nInstall the required Node.js packages:\n    ```bash\n    npm install\n\n### Running the Scripts\n\nTo measure web performance metrics using Puppeteer, follow these steps:\n\n1. **Edit the index.js**\n    - Specify the `webSiteURL` URL you want to analyze.\n    - Specify the `iterations` you want the test to run.\n\n2. **Execute the Script**  \n   Run the performance script using the following command:\n   ```bash\n   node index.js\n\n3. **Review Metrics**  \n   Once the script completes execution, the results will include key performance metrics, such as:\n\n    - **Time to First Byte (TTFB) in ms**  \n      Measures the time it takes for the server to send the first byte of the response after the request is made.  \n      *Example*: `0.5 seconds`\n\n    - **First Contentful Paint (FCP) in ms**  \n      Indicates the time when the first visible content (e.g., text, image) appears on the screen.  \n      *Example*: `1200`\n\n    - **Largest Contentful Paint (LCP) in ms**  \n      Represents the time when the largest visible content (e.g., hero image, headline) is fully rendered.  \n      *Example*: `200`\n\n    - **Cumulative Layout Shift (CLS)**  \n      Quantifies the visual stability of a web page by tracking unexpected layout shifts during loading.  \n      *Example*: `0.03`\n\n### Example Output\n```string\nFCP: 1434, LCP: 5034.0999999940395, CLS: 1.303931890839797, TTFB: 666.5\n```\n\n## Resources\n\nHere are some useful links and references to help you understand web performance metrics and work with Puppeteer:\n\n- [Puppeteer Documentation](https://pptr.dev/)  \n  Official documentation for Puppeteer, providing detailed guides, API references, and examples.\n\n- [Web Performance Metrics](https://web.dev/metrics/)  \n  A comprehensive guide to understanding key performance metrics like FCP, LCP, CLS, and more.\n\n- [Introduction to Puppeteer](https://developers.google.com/web/tools/puppeteer)  \n  An overview of Puppeteer and its use cases, written by Google’s web developers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebengage%2Fwe-web-performance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebengage%2Fwe-web-performance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebengage%2Fwe-web-performance/lists"}