Project Title: Division of Drinking Water (DDW) WaterLink Application Modernization
Project Description: The purpose of this project is to develop an improved web application to replace an existing legacy application called WaterLink. The application will be built on a modern tech stack using NodeJS, ReactJS, and serverless technology.
Project Owner/Client: Division of Drinking Water / Rich Peterson / Blake Shaffer
Date: 11/14/2024
Objectives and Scope of Work
Objective : The goal of this project will be to merge the new application with the legacy version creating a seamless transition between modules and features for both the legacy application and the new WaterLink application. New WaterLink will serve as the landing page, and link back to the legacy system where necessary, facilitating an incremental upgrade strategy.
Scope of Work : List specific tasks the contractor will be responsible for:
Development features:
Enhanced User Management & Portal Access
New UX, landing page, menuing & navigation
Enhancing legacy WaterLink menuing to match new application
Module development:
DDW Report modules (IPS, Bacterial Summary, Inventory, Population, Water Monitoring)
Water Use Reporting
Exceptions
Loan Tracker
Code integration and testing
Documentation and knowledge transfer
Bug fixing and basic troubleshooting
Exclusions : Tasks outside of the contractor's responsibility to avoid scope creep.
UX design
Deliverables
Enhanced User Management & Portal Access
Objective: Update user authentication to support UtahID SSO Methods and implement role-based access controls.
Tasks:
Set up user authentication using NodeJS with a secure API.
Integrate a centralized identity management system
Configure portal access with user dashboards based on roles and admin rights.
New UX, Landing Page, Menuing & Navigation
Objective: Design a modern, responsive landing page in ReactJS to act as the entry point for users.
Tasks:
Develop a ReactJS-based landing page with updated branding and UX.
Develop based on provided UX designs and ensure all development aligns with Utah Design principles.
Conduct usability testing to ensure intuitive navigation across old and new systems.
Enhancing Legacy WaterLink Menuing to Match New Application
Objective: Integrate navigation styles across the legacy and new systems for visual and functional continuity.
Tasks:
Work with legacy system code to implement menu updates where possible to align with V2 menuing.
Add a React-based wrapper component or implement other methods to allow the new application to link directly to legacy menus without confusion.
Test seamless navigation across systems to maintain user familiarity and reduce cognitive load.
Module Development
Objective: Develop and deploy specific modules to support data and reporting functionality.
Tasks for Each Module:
DDW Report Modules: Build React components to display dynamic reports for IPS, Bacterial Summary, Inventory, and Water Monitoring, utilizing serverless functions for data retrieval from SDWIS.
Water Use Reporting: Update form components in ReactJS with data validation for user inputs, linked to a serverless backend to store reports and migrate data to live in the new WaterLink application environment.
Exceptions & Loan Tracker: Develop interfaces for exception tracking and loan management, leveraging serverless database interactions for lightweight storage and easy scaling.
Code Integration and Testing
Objective: Ensure seamless operation between the new application and the legacy system through comprehensive integration and testing.
Tasks:
Use DTS teams procedures and protocols for unit and integration testing of React components and NodeJS services.
Set up serverless deployment pipelines for continuous integration and delivery (CI/CD) using GitHub Actions.
Establish staging environments that mirror production to test user flows between old and new modules.
Documentation and Knowledge Transfer
Objective: Provide detailed documentation and training to ensure future teams can maintain and expand the platform.
Tasks:
Write comprehensive documentation for all new modules, including architecture, endpoints, and data flows.
Develop guides and/or video tutorials for internal users on managing the new system.
Conduct training sessions and hand over codebase insights and best practices as needed.
Bug Fixing and Basic Troubleshooting
Objective: Ensure a smooth user experience by resolving issues swiftly as they arise from testing.
Tasks:
Monitor error logs and performance metrics for new and legacy features.
Set up alerts for critical failures or downtime using AWS CloudWatch or a similar monitoring service.
Implement a feedback loop with users for continuous improvement .
Contractor Responsibilities
Expected Working Hours & Office Expectations:
40 hours per week. Contractor is expected to be available and in the office (195 North 1950 West, Salt Lake City, UT 84116) Tuesday and Thursday of each week.
Contractor will be expected to adhere to the Government of Operations Code of Conduct Policy section 3.5 E: Employees shall dress appropriately and professionally for their assigned job in both in-person and virtual work environments. Basic elements for appropriate and professional attire include clothing that is neat and clean. Managers or supervisors may determine if an employee is dressed appropriately for the workplace or situation.
Collaboration: Contractor will be expected to engage with relevant stakeholders, attend team standup, retrospectives, and sprint planning sessions. The contractor will be expected to report on progress against deliverables and track time in an effective manner.
Project Management Tools: The contractor will be expected to utilize the following tools to support tracking work and progress: