EnvironmentalApp

Software Engineering Group Project

Team Members

• Jack Millar
• Syeda
• Abbie

Project Description

The goal of this project is to develop a cross-platform application to enhance monitoring of local environmental conditions. There are three categories of environmental data that will be monitoried

• Air Quality
• Water Quality
• Weather Conditions

Requirements

According to the Environmental Scientist, the application will be required to:

• Manage sensor accounts and configure settings.
• View and analyse historical environmental data.
• Receive real-time alerts on threshold breaches, displayed on an interactive map
• Generate comprehensive reports on environmental trends.
• Use a map to view real-time sensor statuses and alerts geographically.
• Locate and navigate to sensors in the field for maintenance or inspection purposes.

According to the Operations Manager, the application will be required to:

• Monitor the operational status of sensors.
• Schedule maintenance and ensure timely checks.
• Verify the accuracy and integrity of collected data.
• Address and report sensor malfunctions or anomalies.

According to the Administrator, the application will be required to:

• Manage user access and roles within the application.
• Maintain high levels of system security and data protection.
• Update sensor configurations and firmware.
• Oversee data storage and implement backup strategies.

Technologies

This application will be built in C# MAUI to enable cross-platform operation. Data management will be handled by a SQL Server database, with provided example datasets. Code control and task management will be handled using Github.

Development Tasks

Each team member will be responsible for the completion of at least 3 seperate development tasks related to the user stories provided, one for each role.

Jack:
Environmental Scientist :

• Use a map to view real-time sensor statuses and alerts geographically.
  Operations Manager :
  
• Address and report sensor malfunctions or anomalies.
  Administrator:
  
• Manage user access and roles within the application
  

Zee:
Environmental Scientist :

• Locate and navigate to sensors in the field for maintenance or inspection purposes.
  Operations Manager :
  
• Monitor the operational status of sensors
  Administrator :
  
• Oversee data storage and implement backup strategies
  

Abbie:
Environmental Scientist:
• View and analyse historical environmental data
Operations Manager:
• Schedule maintenance and ensure timely checks.
Administrator:
• Update sensor configurations and firmware

Task Priorites

For each task, Project Members must:

• Document the requirement elaboration in a GitHub issue in consultation with the rest of the team. (LO4)
• Create or update UML diagrams to visualise the application design. All documentation must be version-controlled. (LO1)
• Develop the application features using .NET MAUI, with a focus on code quality and user experience. (LO1)
• Implement unit tests for all public methods. (LO3)
• Document the quality of your code using appropriate metrics. (LO2)
• Generate HTML documentation to describe your code. (LO4)
• Use a systematic workflow for branching, pull requests, and code reviews. (LO2)
• Respond promptly to code review feedback and implement necessary changes. (LO2)
• Describe how the team's branching strategy supports both critical bug fixes and new feature development. (LO4)
• Take an active role in code reviews for peers to ensure code quality and adherence to project standards. (LO2)

Notes

The purpose of the project is not to deliver a fully working system. Instead, it is to demonstrate the teams software engineering skills in the context of an ongoing project. They will be prioritising quality over quantity.