Project-MicroSaaS System Requirements Document

Introduction

Project-MicroSaaS is a niche SaaS solution designed to cater to specific needs within the solar installation, hardware brand warranty management, and small manufacturing sectors. The focus is on delivering micro-ERP slices that can be scoped down to micro-SaaS, providing targeted solutions for job tracking, compliance documentation, warranty management, and operational efficiency.

System Overview

Project-MicroSaaS aims to integrate three core functionalities into a cohesive platform:

1. Solar Installation Project Tracking: A tool for solar installers to track Bill of Materials (BOM), installation milestones, photos, signed forms, and warranty documents per site. The solution is mobile-first with offline support.
2. Warranty and Service Call Management: A B2B2C tool for small hardware brands to manage product registrations, service calls, and automated status updates through an embedded widget.
3. OEE and Downtime Logging: A micro-tool for small manufacturing shops to log downtime and calculate Overall Equipment Effectiveness (OEE), providing clear dashboards for factory managers.

Source Content Inventory

• bigideasdb: Reference for micro-SaaS ideas in construction, installation, and manufacturing industries.

Functional Requirements as Story Points

• As a solar installer, I should be able to track BOM, installation milestones, and warranty documents per site.
• As a solar installer, I should be able to upload photos and signed forms for each installation site.
• As a solar installer, I should be able to access project data offline.
• As a hardware brand, I should be able to embed a widget in my site/app for product registration and service call management.
• As a customer, I should be able to register my product and raise service calls through the embedded widget.
• As a customer, I should receive automated status updates for my service calls.
• As a factory manager, I should be able to log downtime events and calculate OEE.
• As a factory manager, I should be able to view clear dashboards that display operational efficiency metrics.

User Personas

• Solar Installer: Responsible for managing solar installation projects, tracking materials, and ensuring compliance with documentation requirements.
• Hardware Brand Representative: Manages product registrations and service call processes for customers.
• Customer: Registers products and raises service calls through the brand's site/app.
• Factory Manager: Oversees manufacturing operations, logs downtime, and monitors efficiency metrics.

Core User Flows

• Solar Installer tracks project -> uploads photos and forms -> accesses data offline -> updates milestones
• Customer registers product -> raises service call -> receives status updates
• Factory Manager logs downtime -> calculates OEE -> views efficiency dashboard

Visuals Colors and Theme

• primary: #2E8B57 (Sea Green)
• primary_light: #66CDAA (Medium Aquamarine)
• secondary: #FF6347 (Tomato)
• accent: #FFD700 (Gold)
• highlight: #FFA500 (Orange)
• bg: #F5F5F5 (White Smoke)
• surface: rgba(255, 255, 255, 0.9)
• text: #333333 (Dark Gray)
• text_muted: #777777 (Gray)
• border: rgba(0, 0, 0, 0.1)

Signature Design Concept

Interactive Solar Installation Map

The homepage features an interactive map where solar installation sites are marked. Users can click on a site to view detailed project information, including BOM, milestones, and uploaded documents. The map dynamically updates with real-time data and allows users to filter by project status. This concept uses motion/react for smooth transitions and interactions.

LANDING HERO MOTION BRIEF

The landing page showcases a dynamic illustration of a solar panel transforming sunlight into energy. The animation begins with sunlight rays hitting the panel, which then powers a small animated cityscape. This looped animation, created with motion/react, highlights the transformation of solar energy into usable power, emphasizing the project's focus on renewable energy solutions.

Interaction Model & Motion Direction

• Interaction Model: Animated
• The landing page features moderate scroll-triggered reveals and hover transitions, with spring physics applied to interactive elements. This approach provides a polished experience suitable for a feature-rich product page.

Non-Functional Requirements

• The system should support mobile-first design principles.
• API integration for seamless data exchange between modules.
• Offline access for solar installation project data.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB
• AI Tools: Not specified
• Orchestration: Docker, docker-compose

Assumptions and Constraints

• The platform will primarily serve users in the solar installation, hardware brand, and manufacturing sectors.
• The system must handle multiple concurrent users and provide real-time updates.
• Offline capabilities are essential for solar installation project tracking.

Glossary

• BOM: Bill of Materials
• OEE: Overall Equipment Effectiveness
• B2B2C: Business to Business to Consumer

This document outlines the requirements and design concepts for Project-MicroSaaS, ensuring a comprehensive solution tailored to the needs of solar installers, hardware brands, and manufacturing shops.