EstiMATES8080aI System Requirements Document

1. Introduction

EstiMATES8080aI is a project designed to assist homeowners in creating accurate renovation estimates, specifically starting with flooring projects. The platform will allow contractors to bid on job estimates, and it will feature ad space for suppliers and stores to market their products to both homeowners and contractors.

2. System Overview

The EstiMATES8080aI system is a web-based platform that facilitates the creation of renovation estimates by homeowners. It enables contractors to view and bid on these estimates. Additionally, the platform includes advertising space for suppliers and stores to reach both homeowners and contractors. The initial focus will be on flooring projects, with potential expansion to other renovation areas in the future.

3. Functional Requirements

• As a Homeowner, I should be able to create a flooring renovation estimate.
• As a Contractor, I should be able to view available job estimates.
• As a Contractor, I should be able to submit bids on job estimates.
• As a Supplier, I should be able to purchase ad space to market products to homeowners and contractors.
• As a Store, I should be able to purchase ad space to market services to homeowners and contractors.

4. User Personas

• Homeowner: Individuals looking to renovate their homes, starting with flooring projects.
• Contractor: Professionals seeking to bid on renovation projects and provide services.
• Supplier: Companies offering materials and products for renovation projects.
• Store: Retailers providing services and products related to home renovation.

5. Core User Flows

• Homeowner creates estimate -> Contractor views estimate -> Contractor submits bid
• Supplier purchases ad space -> Ad is displayed to homeowners and contractors
• Store purchases ad space -> Ad is displayed to homeowners and contractors

6. Visuals Colors and Theme

• primary: #2A9D8F (Teal)
• primary_light: #A8DADC (Light Teal)
• secondary: #E76F51 (Coral)
• accent: #F4A261 (Orange)
• highlight: #E9C46A (Gold)
• bg: #F1FAEE (Off-white)
• surface: rgba(233, 233, 233, 0.8)
• text: #264653 (Dark Blue)
• text_muted: #6D6875 (Muted Gray)
• border: rgba(38, 70, 83, 0.2)

7. Signature Design Concept

The homepage of EstiMATES8080aI will feature an interactive 3D floor plan visualization using @react-three/fiber. Users can click on different sections of the floor plan to explore various renovation options and see estimated costs. As users hover over different areas, tooltips will provide additional information about materials and potential contractors. This dynamic and engaging interface will make the estimation process intuitive and visually appealing.

8. Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, creating a layered depth effect as users scroll through the page. Decorative elements such as floating material samples and animated contractor tools will move at different speeds, enhancing the storytelling aspect of the platform. Internal pages will adopt a "static" model to ensure clarity and ease of use for detailed estimate creation and bidding processes.

9. Non-Functional Requirements

• The system should be accessible and user-friendly for all user personas.
• The platform must support high traffic volumes due to ad space and bidding activities.
• Security measures must be in place to protect user data and transactions.

10. Tech Stack

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

11. Assumptions and Constraints

• The initial focus is on flooring projects, with potential expansion to other renovation types.
• The platform will be monetized through ad space sales to suppliers and stores.
• The system must comply with Canadian regulations and standards for online transactions.

12. Glossary

• Estimate: A calculated approximation of the cost for a renovation project.
• Bid: A proposal by a contractor to undertake a project at a specified price.
• Ad Space: Areas on the platform where suppliers and stores can display advertisements.
• Parallax: A visual effect where background images move slower than foreground images, creating a sense of depth.