README

Estimate your web page carbon footprint

Installation

$ composer require akhela/website-carbon-calculator

API

Estimate web page carbon footprint

View the Google documentation to generate a Google Pagespeed Api Key

$websiteCarbonCalculator = new WebsiteCarbonCalculator('GooglePagespeedApiKey');
$websiteCarbonCalculator->calculateByURL('https://www.websitecarbon.com/how-does-it-work/')

Output

{
  "url": "https://www.websitecarbon.com",
  "isGreenHost": true,
  "bytesTransferred": 135289,
  "networkRequests": 16,
  "performanceScore": 0.94,
  "loadingExperience": "FAST",
  "domSize": 308,
  "speedIndex": 934,
  "firstMeaningfulPaint": 491,
  "interactive": 692, 
  "bootupTime": 94,
  "serverResponseTime": 150,
  "mainthreadWork": 762,
  "energy": 0.000171,
  "co2PerPageview": 0.0739
}

For better performance, detect hosting energy type and store it in a database to avoid repetitive call to The Green Web Foundation.

Detect hosting energy type

$isGreenHost = WebsiteCarbonCalculator::isGreenHost('https://www.websitecarbon.com')
$websiteCarbonCalculator->calculateByURL('https://www.websitecarbon.com/how-does-it-work/', ['isGreenHost'=>$isGreenHost])

How does it work

Calculating the carbon emissions of website is somewhat of a challenge, but using five key pieces of data we can make a pretty good estimate:

Data transfer over the wire
Energy intensity of web data
Energy source used by the data centre
Carbon intensity of electricity
Website traffic

Under the hood, it uses Google pagespeed api and The green web foundation api

Website Carbon Calculator

The internet consumes a lot of electricity. 416.2TWh per year to be precise. To give you some perspective, that’s more than the entire United Kingdom.

From data centres to transmission networks to the devices that we hold in our hands, it is all consuming electricity, and in turn producing carbon emissions.

This project is widely inspired by the Website Carbon Calculator algorithm 2.0 and The Green Web Foundation co2.js

Glossary

isGreenHost : server uses sustainable energy
networkRequests : https://web.dev/performance-scoring/
performanceScore : https://web.dev/resource-summary/
domSize : https://web.dev/dom-size/
speedIndex : https://web.dev/speed-index/
firstMeaningfulPaint : https://web.dev/first-meaningful-paint/
interactive : https://web.dev/interactive/
bootupTime : https://web.dev/bootup-time/
serverResponseTime : https://web.dev/time-to-first-byte/
mainthreadWork : https://web.dev/mainthread-work-breakdown/
co2PerPageview : estimated grams of CO2 produced every time someone visits the web page

Tests

Run tests

$ pagespeedApiKey=xxxxxx php vendor/bin/phpunit

akhela / website-carbon-calculator

Maintainers

Details