Energy Label Service

Deployment	Status
Automated tests
Dev
Staging
Prod

Digital service allowing users to create energy labels for a variety of products, such as light bulbs, heaters, televisions and ovens.

Running locally

The service is built using the Spring Boot framework.

First, ensure you have the following prerequisites installed:

• Java 17 (or higher)
• NPM

Then:

1. Clone the project

     git clone https://github.com/UKGovernmentBEIS/energy-label-service.git
     cd energy-label-service
   

2. Build the frontend

     npm install && npx gulp buildAll
   

3. Run with Gradle

     ./gradlew bootRun
   

Deployment

Any code committed to the develop, qa, or master branch (via PR merge or direct commit) will automatically trigger a AWS CodePipeline workflow to build and deploy to the dev, staging and prod environments respectively.

Changes should first be made on develop, merged to qa and then finally master once completed and QA'd. Merges should be done using the --ff-only option in order to avoid merge commits which will de-sync the branches.

E.g. to push the contents of develop to the QA environment run:

git checkout qa
git merge develop --ff-only
git push

The badges at the top of the readme show the current deployment status for each environment. Click them to view the full pipeline (you will need to be logged in to the BEIS AWS PaaS).

Modifying existing products

The vast majority of product 'config' (e.g. field prompts, hint text, validation rules etc) resides in the form object for the given product. E.g. to change the on screen text for the Dishwashers, edit the DishwashersForm.

To change a visual aspect of the generated label, modify the SVG template used to render the PDF. E.g. dishwashers.svg

Adding new products

Adding a new product requires:

• An SVG template used to render the PDF
• A form object which defines all the fields the user must fill in
• A service to populate the SVG template given a form
• Controller routes

If the product is an entirely new category of products, add an entry to the ProductCategory list.

If the new product category also contains sub-categories, add a new implementation of the Category interface, and extend the CategoryController in your products controller.