Skip to content

alexandrejflopes/tqs-air-quality-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TQS Air Quality Meter

Minimalist web app that provides details on air quality for a certain region/city

Overview

This application is the result of an assignment of the Software Quality And Tests course. The goal was to develop a multi-layer web application in Spring Boot with automated tests of different types (unit tests, service level tests, integration tests, and functional testing, mainly on the web interface).
In particular, this application should provide details on air quality for a given location (provided by the user) showing metrics like particles in suspension or gases present. To achieve these objectives, the project should include different components: a web page, that allows the interaction with the user; integration with external sources, like a third-party API to fetch that air quality data; an in-memory cache to save the latest results from that API; and its own REST API that can be called by external clients and obtain air quality data as well.

How to run

The application project is the folder "airquality" in this repository. This will be our root directory.
You can test this application by downloading the source code in this repository and run it directly from your favorite IDE.
If you prefer, you can run it throught the command line. For that, you can execute mvn spring-boot:run in the root of the project or run the packaged application version (a JAR) executing java -jar <jar_path>, being jar_path the path of JAR archive of the application. You can find it in the "executable jar" folder of this repository.
Once the application is running, you can access the url http://localhost:8080/ in your web browser and interact with the user interface.

Documentation

More information about the overall project development and the developed API can be seen in the report available in this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Minimalist web app that provides details on air quality for a certain region/city

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published