Calculate the environmental impact of a webpage and display it in your GitHub project as a Shields.io badge.
The CO₂ Shield allows you to assess the environmental impact of your project's web page and showcase it in your GitHub project as a Shields.io badge. It is powered by Beacon, which utilises the OneByte model developed by The Shift Project to calculate emissions.
You don't need to download or initialise anything to use this application. Visit the live version here:
Here's an example of a badge preview and the markdown generated by the application for our website's homepage overbrowsing.com:
Preview
Markdown
[](https://overbrowsing.com/projects/co2-shield)
These measurements are for new visitors. Returning visitors have a lower footprint due to caching.
| Rating | Color | CO₂e Emissions per View |
|---|---|---|
| A+ | Less than 0.095g | |
| A | Less than 0.185g | |
| B | Less than 0.34g | |
| C | Less than 0.49g | |
| D | Less than 0.65g | |
| E | Less than 0.85g | |
| F | Above 0.85g |
To use CO₂ Shield in your project, you can install it via NPM:
npm install co2-shield
After installation, import and use the library in your project:
import CO2Shield from "co2-shield";
const co2Shield = new CO2Shield("app-container");
co2Shield.initialize();
Ensure you are running your project with a bundler like Webpack, Vite, or Parcel that supports ES modules.
<script> Tag)If you prefer not to use a package manager, you can include the library directly in your HTML using a CDN like UNPKG:
<!DOCTYPE html>
<html lang="en-GB">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<title>CO₂ Shield</title>
</head>
<body>
<!-- 1. Create the App Container -->
<div id="app-container"></div>
<!-- 2. Add the Library via CDN -->
<script src="https://unpkg.com/co2-shield/dist/index.js" type="module"></script>
</body>
</html>
Contributions are welcome. Please feel free to submit an issue or a pull request.
CO₂ Shield is released under the MIT license. Feel free to use and modify it as needed.
FAQs
Calculate the environmental impact of a webpage and display it in your GitHub project as a Shields.io badge.
We found that co2-shield demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.