Skip to content

Sitespeed.io is an open source tool that helps you analyze and optimize your website speed and performance, based on performance best practices advices from the coach and collecting browser metrics using the Navigation Timing API, User Timings and Visual Metrics (FirstVisualChange, SpeedIndex & LastVisualChange).

License

paulbankert/sitespeed.io

 
 

Repository files navigation

sitespeed.io

Build status Downloads Docker Stars Changelog #212

Website | Documentation | Twitter

Welcome to the wonderful world of web performance!

IMPORTANT: Master is now the coming 6.0. If you need to a patch release, use the 5.x branch. 6.0 is going to be released sometimes after Firefox 57.

Using sitespeed.io you can:

  • Test your web site against Web Performance best practices using the Coach.
  • Collect Navigation Timing API, User Timing API and Visual Metrics from Firefox/Chrome using Browsertime.
  • Run your custom-made JavaScript and collect whichever metric(s) you need.
  • Test one or multiple pages, across one or many runs to get more-accurate metrics.
  • Create HTML-result pages or store the metrics in Graphite.
  • Write your own plugins that can do whatever tests you want/need.

See all the latest changes in the Changelog.

If you use Firefox 55 (or later) please have a look at sitespeedio/browsertime#358. When 57 is released we think there will be a easy way to fix it :)

Examples of what you can do

Checkout our example dashboard.sitespeed.io

A summary report in HTML:

Individual page report:

Collected metrics from a URL in Graphite/Grafana:

Video - easiest using Docker. This gif is optimized, the quality is much better IRL:

Lets try it out

Using Docker (requires 1.10+):

$ docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io --video --speedIndex https://www.sitespeed.io/

Or install using npm:

$ npm i -g sitespeed.io

Or clone the repo and test the latest changes:

$ git clone https://github.com/sitespeedio/sitespeed.io.git
$ cd sitespeed.io
$ npm install
$ bin/sitespeed.js --help
$ bin/sitespeed.js http://www.sitespeed.io

I want to help!

We have a special page for you!

Contributors

All the love in the world to our contributors:

mcdadounadatstefanjudisshakey2k2lbodtollmanz

laerpixelsonlypelmeredstaabmalimonykrukru

AD7sixabhaguptaadamstacsvetlyak40wtantonbabenkoakupila

bbvmediacgoldbergdanielsamuelsmarcbachmannEikeDawidemilb

gehelIxl123jeremy-greenjerodsantojjethwakeithamus

omegahmschmilblickrob-matdtmatthojoorjan

moosradumJeroenVdbpborrelijzoldakn3o77

stephendonner

About

Sitespeed.io is an open source tool that helps you analyze and optimize your website speed and performance, based on performance best practices advices from the coach and collecting browser metrics using the Navigation Timing API, User Timings and Visual Metrics (FirstVisualChange, SpeedIndex & LastVisualChange).

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 45.2%
  • CSS 40.2%
  • HTML 14.1%
  • Shell 0.5%