{"id":13610603,"url":"https://github.com/axemclion/browser-perf","last_synced_at":"2025-04-08T13:08:15.425Z","repository":{"id":12402812,"uuid":"15056077","full_name":"axemclion/browser-perf","owner":"axemclion","description":"Performance Metrics for Web Browsers","archived":false,"fork":false,"pushed_at":"2018-02-12T15:04:24.000Z","size":464,"stargazers_count":935,"open_issues_count":18,"forks_count":68,"subscribers_count":38,"default_branch":"master","last_synced_at":"2024-04-14T18:04:28.487Z","etag":null,"topics":["browser-perf","javascript","metrics","perfmatters","performance","performance-metrics","web-performance","wiki-page"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/axemclion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-12-09T18:56:33.000Z","updated_at":"2024-02-17T15:05:47.000Z","dependencies_parsed_at":"2022-09-01T14:42:00.876Z","dependency_job_id":null,"html_url":"https://github.com/axemclion/browser-perf","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/axemclion%2Fbrowser-perf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axemclion%2Fbrowser-perf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axemclion%2Fbrowser-perf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axemclion%2Fbrowser-perf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/axemclion","download_url":"https://codeload.github.com/axemclion/browser-perf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247847611,"owners_count":21006100,"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":["browser-perf","javascript","metrics","perfmatters","performance","performance-metrics","web-performance","wiki-page"],"created_at":"2024-08-01T19:01:46.211Z","updated_at":"2025-04-08T13:08:15.407Z","avatar_url":"https://github.com/axemclion.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# browser-perf\n\n- Is a NodeJS based tool\n- For measuring browser performance metrics (like frame rates, expensive layouts, paints, styles, etc.) \n- For Web pages, Cordova/Phonegap and other Hybrid applications. \n- Metrics are measured while mimicking real user interactions - clicking buttons, typing content, etc.  \n- Tool collects the metrics from sources like `about:tracing`, Chrome Devtools timeline, IE UI Responsiveness tab, Xperf, etc. \n- Monitor this information regularly by integrating the tool with continuous integration systems. \n\n## Documentation \nRead more on [why browser-perf here](https://github.com/axemclion/browser-perf/wiki#why-browser-perf-).\n\nPlease see the [wiki pages](https://github.com/axemclion/browser-perf/wiki/_pages) for more information. \nYou can find information about supported browsers, [getting started](https://github.com/axemclion/browser-perf/wiki/Setup-Instructions), [command line usage](https://github.com/axemclion/browser-perf/wiki/Command-Line-Usage), reference for the [Node API](https://github.com/axemclion/browser-perf/wiki/Node-Module---API) etc. \n\n## Usage\n\n### Command line\n\nInstall the tool using `npm install -g browser-perf` and then run \n\n```\n$ browser-perf http://yourwebsite.com --browsers=chrome,firefox --selenium=ondemand.saucelabs.com --username=username --accesskey=accesskey\n```\n\n- Replace username and access key with the [saucelabs.com](http://saucelabs.com) username and accesskey\n- If you have [Selenium](http://www.seleniumhq.org/download/) set up, you could substitute `ondemand.saucelabs.com` with `localhost:4444/wd/hub`\n- You can also use [BrowserStack](http://browserstack.com) credentials and substitute `ondemand.saucelabs.com` with `hub.browserstack.com`\n\nSee the [wiki page](https://github.com/axemclion/browser-perf/wiki/Command-Line-Usage) for an extensive list of command line options and more usage scenarios.\n\nHere is a video of the command line usage\n[![Demo of browser-perf](https://img.youtube.com/vi/0HmAFrUCIUI/0.jpg \"Demo of browser-perf\")](https://www.youtube.com/watch?v=0HmAFrUCIUI)\n\n## Node Module\n\nbrowser-perf is also a node module and has the following API\n\n```javascript\n\nvar browserPerf = require('browser-perf');\nbrowserPerf('/*URL of the page to be tested*/', function(err, res) {\n\t// res - array of objects. Metrics for this URL\n\tif (err) {\n\t\tconsole.log('ERROR: ' + err);\n\t} else {\n\t\tconsole.log(res);\n\t}\n}, {\n\tselenium: 'http://localhost:4444/wd/hub',\n\tbrowsers: ['chrome', 'firefox']\n\tusername: SAUCE_USERNAME // if running tests on the cloud  \n});\n\n```\nSee the [API wiki page](https://github.com/axemclion/browser-perf/wiki/Node-Module---API) for more details on configuring. \nInstructions on using it for Cordova apps is also on the [wiki](https://github.com/axemclion/browser-perf/wiki/Setup-Instructions#wiki-cordova-applications)\n\n## Scenario\n- Websites can become slow\n  - over time as more CSS and Javascript is added\n  - due to a single commit that adds expensive CSS (like gradients) \n- We use tools in [Chrome](https://developers.google.com/chrome-developer-tools/docs/timeline) or [Internet Explorer](http://msdn.microsoft.com/en-us/library/ie/dn255009%28v=vs.85%29.asp) only when the site is too slow. \n- Tools like YSlow and Page Speed are great, but will it not be better if the are a part of continuous integration?\n- Tools like this(http://npmjs.org/package/browser-perf) and [Phantomas](https://github.com/macbre/phantomas) can fill the gap to monitor site performance every time a checkin is performed. \n\n## License\nLicensed under BSD-2 Clause. See License.txt for more details \n\n## Contact\nPlease ping [me](http://twitter.com/nparashuram) if you would need help setting this up. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxemclion%2Fbrowser-perf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxemclion%2Fbrowser-perf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxemclion%2Fbrowser-perf/lists"}