Newway Aqua Tech System Requirements Document

Introduction

The Newway Aqua Tech project aims to develop a comprehensive application for monitoring and managing various operational aspects of a water treatment plant. This includes employee attendance, salary management, working days, flow meter readings, and hypo chemical usage. The application will provide both administrative and employee-specific functionalities to ensure efficient plant operations.

System Overview

The Newway Aqua Tech application is designed to streamline the management of water treatment plant operations. It will provide real-time monitoring and data management capabilities, allowing administrators to track employee activities, manage payroll, and monitor operational metrics such as flow meter readings and chemical usage. The application will also enable employees to record their attendance and access relevant operational data.

Functional Requirements

• As an Admin, I should be able to monitor employee attendance, including punch in/out times and location.
• As an Admin, I should be able to manage employee salaries and working days.
• As an Admin, I should be able to view and analyze flow meter readings.
• As an Admin, I should be able to monitor hypo chemical usage.
• As an Employee, I should be able to punch in and out, with my location being recorded.
• As an Employee, I should be able to view my attendance records.
• As an Employee, I should be able to access flow meter reading details.
• As an Employee, I should be able to access hypo chemical usage details.

User Personas

• Admin: Responsible for overseeing plant operations, managing employee records, and analyzing operational data.
• Employee: Plant workers who need to record attendance and access specific operational data related to their tasks.

Core User Flows

• Admin logs into the system -> Views employee attendance records -> Manages salary and working days -> Monitors flow meter readings and hypo chemical usage.
• Employee logs into the system -> Punches in/out with location recording -> Views personal attendance records -> Accesses flow meter and hypo usage details.

Visuals Colors and Theme

• primary: #1A73E8 (a deep blue representing water and technology)
• primary_light: #4D90FE (a lighter blue for hover states and secondary UI)
• secondary: #FF7043 (a coral hue for emphasis and headlines)
• accent: #FFC107 (a vibrant amber for CTAs and active states)
• highlight: #FFB300 (a warm gold for hover states and notifications)
• bg: #F5F5F5 (a light grey for the page background)
• surface: rgba(255, 255, 255, 0.9) (a white card/panel background)
• text: #212121 (a dark grey for primary text)
• text_muted: #757575 (a softer grey for secondary text)
• border: rgba(0, 0, 0, 0.1) (a subtle border color)

Signature Design Concept

The Newway Aqua Tech homepage will feature an interactive water ripple effect that responds to user interactions. As users move their cursor across the screen, ripples will form and spread, creating a dynamic and engaging experience. This effect will be implemented using framer-motion for smooth animations and gsap for scroll-triggered interactions. The homepage will also include animated icons representing different operational metrics, which users can click to access detailed information. This design will provide an immersive and intuitive interface that reflects the project's focus on water treatment and technology.

Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, creating a layered depth effect as users scroll. Decorative elements, such as water ripples and animated icons, will move at different speeds, enhancing the visual storytelling. Internal pages will adopt a "static" interaction model to prioritize clarity and ease of use for data-heavy tasks.

Non-Functional Requirements

• The system must ensure data security and privacy for all user information.
• The application should be responsive and accessible on various devices, including desktops and mobile devices.
• The system should support real-time data updates and notifications.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: Not applicable
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The application will be used primarily by water treatment plant staff in India, with locale-specific defaults such as time zone and currency.
• The system must integrate with existing plant infrastructure for data collection and monitoring.

Glossary

• Flow Meter: A device that measures the volume or mass of a fluid moving through a pipe.
• Hypo Chemical: Refers to sodium hypochlorite, commonly used for disinfection in water treatment.
• Punch In/Out: The action of recording the start and end of a work period by an employee.