System Requirements Document for easy-solar

1. Introduction

The easy-solar project is a lightweight, mobile-first SaaS designed for Indian solar installers and EPCs (Engineering, Procurement, and Construction). It focuses on providing fast, professional proposals and simple customer management without the complexity of 3D modeling. The primary audience includes small EPCs and solar installers in India who require efficient tools for lead management, solar design, BOM/BOQ generation, subsidy checks, proposal creation, and post-sale tracking.

2. System Overview

The easy-solar system is a web-based application that will transition to a mobile-first approach upon request. It supports solar EPCs in managing customer leads, designing solar systems, generating proposals, and tracking projects. The system is designed to work on low-end Android phones, ensuring accessibility for field teams in Tier-2/3 cities. The product does not include complex 3D modeling but instead uses lightweight 2D/rule-based solar design.

2a. Product Interpretation and Delivery Boundary

The product is delivered as a web-based application with a focus on Indian solar installers and EPCs. It includes features for lead capture, customer management, solar design, BOM/BOQ generation, subsidy checks, and proposal creation. The application supports WhatsApp-ready proposal sharing and allows for branding customization. The system requires user authentication and authorization for accessing shared records and functionalities. Mobile-first implementation is deferred until explicitly requested.

2b. Source Content Inventory

Not applicable as no content_source directive is provided.

2c. Page Content and Component Coverage

Landing

• Information: Overview of the solar EPC proposal, design, quotation, and customer-management product.
• Actions: Navigate to Login or learn more about the product.
• Components: Hero section with solar-themed schematic diagram, CTA buttons.

Login

• Information: User authentication interface.
• Actions: Login for returning users, account creation for new users.
• Components: Login form, account creation link.

Dashboard

• Information: Summary of pipeline, tasks, active designs, proposals, projects, and service work.
• Actions: Navigate to Leads, Customer Details, Tasks, Designs, Configurations, Costing, Scheme Checks, Proposals, Projects, Service.
• Components: Navigation panel, summary widgets.

Leads

• Information: Lead and customer records with lifecycle statuses.
• Actions: Capture new leads, search and browse existing leads, update lead status.
• Components: Lead capture form, lead lifecycle tracker.

Customer Details

• Information: Customer profile including contact, site, bill photo, load, roof, and budget information.
• Actions: Update customer details, view customer history.
• Components: Customer profile form, history log.

Tasks

• Information: Task management for follow-ups and site visits.
• Actions: Schedule new tasks, mark tasks as complete.
• Components: Task scheduler, task list.

Designs

• Information: 2D/rule-based solar design workspace.
• Actions: Create new designs, revisit existing designs.
• Components: Design input form, design list.

Design Results

• Information: Calculated system size, panels, strings, inverter sizing, and estimated generation.
• Actions: Review design results, make adjustments.
• Components: Design results display, adjustment tools.

Configurations

• Information: System configuration options (basic, premium, with battery).
• Actions: Create and compare configurations.
• Components: Configuration form, comparison tool.

Costing

• Information: BOM/BOQ generation and cost calculations.
• Actions: Generate BOM/BOQ, calculate costs.
• Components: Costing calculator, BOM/BOQ generator.

Scheme Checks

• Information: Subsidy estimation, ALMM compliance validation, net-metering feasibility.
• Actions: Check subsidy eligibility, validate compliance.
• Components: Scheme check tools, compliance validator.

Proposals

• Information: Proposal and quotation PDF generation.
• Actions: Generate proposals, prepare for WhatsApp sharing.
• Components: Proposal generator, sharing options.

Projects

• Information: Post-sale project tracking.
• Actions: Transition projects to Installed or Commissioned, record installation details.
• Components: Project tracker, installation log.

Service

• Information: O&M ticket logging and tracking.
• Actions: Log new tickets, track service visits.
• Components: Ticket log, service tracker.

3. Functional Requirements

• As a Solar EPC / Installer, I should be able to capture leads from WhatsApp, website forms, and referrals.
  Provenance: explicit
  Lifecycle: Initiate lead capture → Store lead details → Update lead status
  Observable Result: Lead captured and stored with initial status.

• As a Solar EPC / Installer, I should be able to store customer details including name, contact, address, electricity bill photo, load, roof type, and budget.
  Provenance: explicit
  Lifecycle: Input customer details → Save details
  Observable Result: Customer details stored in the system.

• As a Solar EPC / Installer, I should be able to track lead status through New, Site Visit, Proposal Sent, Follow-up, Closed, or Lost.
  Provenance: explicit
  Lifecycle: Update lead status → Save status
  Observable Result: Lead status updated and saved.

• As a Solar EPC / Installer, I should be able to support simple task reminders for follow-ups and site visits.
  Provenance: explicit
  Lifecycle: Schedule task → Receive reminder → Complete task
  Observable Result: Task reminder received and task marked complete.

• As a Solar EPC / Installer, I should be able to enter roof dimensions and constraints such as shadow areas, parapet, and water tank.
  Provenance: explicit
  Lifecycle: Input dimensions and constraints → Save design inputs
  Observable Result: Design inputs saved for solar design.

• As a Solar EPC / Installer, I should be able to choose modules and inverters from a pre-loaded ALMM-listed catalog.
  Provenance: explicit
  Lifecycle: Select module/inverter → Save selection
  Observable Result: Module and inverter selection saved.

• As a Solar EPC / Installer, I should be able to automatically calculate system size, approximate panels and strings, inverter sizing, and estimated annual generation based on city/location.
  Provenance: explicit
  Lifecycle: Input design parameters → Calculate system metrics
  Observable Result: System metrics calculated and displayed.

• As a Solar EPC / Installer, I should be able to generate BOM/BOQ for solar materials and calculate material cost, installation cost, and margins.
  Provenance: explicit
  Lifecycle: Generate BOM/BOQ → Calculate costs
  Observable Result: BOM/BOQ and cost calculations completed.

• As a Solar EPC / Installer, I should be able to support multiple configurations such as basic, premium, and with battery.
  Provenance: explicit
  Lifecycle: Create configuration → Save configuration
  Observable Result: Configuration options saved.

• As a Solar EPC / Installer, I should be able to provide PM Surya Ghar / rooftop subsidy eligibility estimation, ALMM compliance checks, and net-metering feasibility hints based on state/DISCOM.
  Provenance: explicit
  Lifecycle: Input scheme parameters → Check eligibility/compliance
  Observable Result: Eligibility and compliance results displayed.

• As a Solar EPC / Installer, I should be able to generate professional proposal PDFs containing system summary, generation and savings, payback/ROI, and warranty/O&M terms, with OPEX/PPA options if supported.
  Provenance: explicit
  Lifecycle: Generate proposal → Save PDF
  Observable Result: Proposal PDF generated and saved.

• As a Solar EPC / Installer, I should be able to support WhatsApp-ready proposal sharing by link or PDF and allow branding/logo configuration.
  Provenance: explicit
  Lifecycle: Prepare proposal for sharing → Share via WhatsApp
  Observable Result: Proposal shared via WhatsApp.

• As a Solar EPC / Installer, I should be able to track projects as Installed or Commissioned, including installation date, system size, and key components.
  Provenance: explicit
  Lifecycle: Update project status → Save installation details
  Observable Result: Project status and details updated.

• As a Solar EPC / Installer, I should be able to provide a simple O&M ticket log for complaints or service visits.
  Provenance: explicit
  Lifecycle: Log ticket → Track service visit
  Observable Result: O&M ticket logged and tracked.

• As a Solar EPC / Installer, I should be able to create an account before accessing protected work.
  Provenance: required_inference
  Lifecycle: Create account → Access system
  Observable Result: Account created and access granted.

• As an EPC Team Member, I should be able to be provisioned or invited into the EPC workspace before accessing shared records.
  Provenance: required_inference
  Lifecycle: Receive invitation → Join workspace
  Observable Result: Access to shared records granted.

• As a returning user, I should be able to verify my identity through Login.
  Provenance: required_inference
  Lifecycle: Enter credentials → Verify identity
  Observable Result: User identity verified.

• As a Solar EPC / Installer, I should be able to have generated proposal PDFs available as a document output before WhatsApp-ready sharing.
  Provenance: required_inference
  Lifecycle: Generate PDF → Prepare for sharing
  Observable Result: PDF available for sharing.

4. User Personas

• Solar EPC / Installer: Responsible for capturing leads, designing solar systems, preparing BOMs and quotations, managing customers, and tracking post-sale work.
• EPC Team Member: Authorized staff who share customer records and perform lead, proposal, and service workflows.

5. Core User Flows

Solar EPC / Installer

1. Capture Lead: Initiate lead capture from WhatsApp → Enter lead details → Save lead with initial status.
2. Manage Customer Details: Access customer profile → Update details → Save changes.
3. Track Lead Status: Select lead → Update status → Save status.
4. Schedule Tasks: Create task for follow-up → Receive reminder → Complete task.
5. Design Solar System: Enter roof dimensions and constraints → Select module/inverter → Calculate system metrics.
6. Generate BOM/BOQ: Input design parameters → Generate BOM/BOQ → Calculate costs.
7. Create Proposal: Generate proposal PDF → Prepare for WhatsApp sharing → Share proposal.
8. Track Projects: Update project status to Installed/Commissioned → Record installation details.
9. Log O&M Tickets: Create new ticket → Track service visit.

EPC Team Member

1. Join Workspace: Receive invitation → Join EPC workspace → Access shared records.
2. Verify Identity: Enter login credentials → Verify identity → Access system.

6. Visuals Colors and Theme

• Muse: Erik Spiekermann
• Palette (light mode):
  • Background: #F7FAFC
  • Surface: #FFFFFF
  • Text: #333333
  • Primary: #FF5722
  • Accent: #FFC107
  • Muted: #E0E0E0
• Typography:
  • Headings: Fira Sans, Medium weight, large size contrast, tight tracking, sentence case
  • Body: Source Sans Pro
  • Scale: 1.25 modular, 48/32/24/18/16
• Shape Language: Clear columns, generous margins, rounded edges for buttons and inputs
• Layout: Structured grid with clear divisions, using whitespace to separate sections
• Motion: Functional transitions and micro-interactions
• Motion Tempo: Restrained
• Hero Dimensionality: Flat
• Imagery: Simple schematic diagrams and iconography, occasional vector-based illustrations

7. Signature Design Concept

The public entry page will feature a full-width header with a solar-themed schematic diagram, using the primary orange for highlights. The layout will be structured with clear divisions and generous use of whitespace to separate content sections. Primary orange CTA buttons will have a slight hover lift for immediate access to actions. Consistent use of humanist sans typography in varying weights will establish hierarchy, and a structured side panel will provide quick navigation and status updates.

8. Interaction Model & Motion Direction

• Interaction Model: Static
• Motion Tempo: Restrained
• Hero Dimensionality: Flat
• Landing Hero Motion Brief: The hero section will feature a schematic diagram of a solar array, highlighted with the primary orange. The text and CTA will be positioned to the right on a clean background, guiding users to learn more or login.

9. Non-Functional Requirements

• Performance: The application must perform efficiently on low-end Android devices.
• Scalability: The system should handle increasing numbers of users and data without performance degradation.
• Security: User data must be protected through secure authentication and authorization mechanisms.

10. Tech Stack

• Frontend: React
• Backend: Python/FastAPI
• Storage: PostgreSQL
• Deployment: Docker, Kubernetes (if required for scaling)

11. Assumptions and Constraints

• The initial implementation is web-based; mobile-first will be implemented upon request.
• The system will not include complex 3D modeling.
• The product is targeted at Indian solar installers/EPCs and will focus on Indian solar schemes and contexts.

12. Glossary

• EPC: Engineering, Procurement, and Construction
• BOM/BOQ: Bill of Materials/Bill of Quantities
• O&M: Operations and Maintenance
• ALMM: Approved List of Models and Manufacturers
• DISCOM: Distribution Company