https://github.com/defra/aqie-citizen-alpha

AQIE = Air Quality & Industrial Emissions. This is the prototype for our Citizen service.
https://github.com/defra/aqie-citizen-alpha

Last synced: 6 days ago
JSON representation

AQIE = Air Quality & Industrial Emissions. This is the prototype for our Citizen service.

• Host: GitHub
• URL: https://github.com/defra/aqie-citizen-alpha
• Owner: DEFRA
• Created: 2023-07-21T13:44:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-31T15:25:47.000Z (over 1 year ago)
• Last Synced: 2024-04-14T07:53:02.773Z (7 months ago)
• Language: CSS
• Size: 276 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AQIE-Citizen-Alpha

AQIE = Air Quality and Industrial Emissions. This is the alpha prototype for our Citizen service.

## Backend

Controllers returning a View have a name prefixed with Display.

## Frontend

The frontend code does not use a JavaScript framework. This is done on purpose to follow progressive enhancement recommended by GDS. See https://www.gov.uk/service-manual/technology/using-progressive-enhancement.

## To dockerize the app

To build AQIE-Citizen-Alpha/Dockerfile, I followed instructions at https://www.baeldung.com/dockerizing-spring-boot-application.

To create an image from the Dockerfile:

- cd AQIE-Citizen-Alpha

- mvn clean install

- docker build --tag=airqualitylimitedjs:latest .

To verify a new image has been built:

- docker image list

- To delete the redundant image image_id: docker image rm image_id

To run the container from our image:

- H2 profile: docker run -e spring.profiles.active=localwithh2 -e OS_MAPPING_KEY=THE_KEY -p8080:8080 airqualitylimitedjs:latest

- PostgreSQL profile: docker run -e spring.profiles.active=localdockerwithpostgre -e OS_MAPPING_KEY=THE_KEY -p8080:8080 airqualitylimitedjs:latest

    - Prerequisite = Start the PostgreSQL container.

## To get code coverage

I followed https://www.baeldung.com/jacoco

Running 'mvn clean install jacoco:report', you get:

- a coverage report in binary format in the target directory, target/jacoco.exec. This can be interpreted by Sonar Qube.

- a readable code coverage report at target/site/jacoco/index.html

## References

https://www.thymeleaf.org/

## TODO

Add html pages: 

    - Page 4 = Nearest air quality to a postcode. 1 text field = Postcode and 1 Submit button.

        - Once submitted, add a table listing air qualities. Cols = AirQualityIndex, Area.

Add a reCAPTCHA.

Unit tests for inputValidation.js