Skip to content

A Vue component to dynamically display scalable Energy Performance Certificates (EPC's)

License

Notifications You must be signed in to change notification settings

gemmadlou/epc-rating

Repository files navigation

Energy Performance Certificate Rating Vue Component

A little Vue 3 component library to display the UK EPC Ratings.

Test, Build and Publish

Install

npm i epc-rating

Usage

<script setup lang="ts">
import EPCRating from 'epc-rating';
</script>

<template>
  <EPCRating 
    :current-score="72" 
    :potential-score="85" 
   />
</template>

EPC Ratings

An Energy Performance Certificate (EPC) shows how energy efficient a property is, with ratings from A to G. The UK Government website provides both the current and potential ratings for a property.

You can find the energy rating for a property here: https://www.gov.uk/find-energy-certificate.

energy-performance-rating

Contributing

This project uses Vite + Vue 3 + TypeScript.

# Install dependencies
npm install

# Run development
npm run dev

# Run tests
npm test

Attributions & Thanks

  • This component uses public sector information licensed under the Open Government Licence v3.0. The SVG is sourced from the UK Government website, with minor adjustments for Vue.js. All EPC-related media assets can be found here. EPC rating diagrams can be generated here.
  • Thanks to Brian Barrow for his guide on creating a Vue 3 component package.
  • Additional thanks to Matija Novosel for his guide on preparing the npm package.