Steel-Bot System Requirements Document

Introduction

The Steel-Bot project aims to develop a lead tracker web application specifically designed for the rental generator business. The application will focus on identifying and adding leads about potential customers for individual use.

System Overview

Steel-Bot is a web-based application that automates the process of finding and managing leads for individuals in the rental generator business. The system will leverage advanced algorithms to identify potential customers and streamline the lead management process, ensuring that users can efficiently track and convert leads into business opportunities.

Functional Requirements

• As an Individual User, I should be able to register and create an account to access the lead tracker.
• As an Individual User, I should be able to log in and log out securely.
• As an Individual User, I should be able to input criteria for potential leads to tailor the search process.
• As an Individual User, I should be able to view a list of potential leads generated by the system.
• As an Individual User, I should be able to add new leads manually.
• As an Individual User, I should be able to edit and update lead information.
• As an Individual User, I should be able to delete leads that are no longer relevant.
• As an Individual User, I should be able to categorize leads based on status (e.g., new, contacted, converted).
• As an Individual User, I should be able to set reminders for follow-up actions with leads.
• As an Individual User, I should be able to export lead data for external analysis or reporting.
• As an Individual User, I should be able to receive notifications about lead updates or reminders.

User Personas

• Individual User: A person involved in the rental generator business who uses the application to track and manage potential customer leads.

Core User Flows

1. Individual User registers -> logs in -> inputs lead criteria -> views generated leads -> adds/edit/deletes leads -> categorizes leads -> sets reminders -> exports data.
2. Individual User logs in -> receives notifications -> updates lead status -> logs out.

Visuals Colors and Theme

• primary: #1E3A8A (Deep Blue)
• primary_light: #3B82F6 (Light Blue)
• secondary: #F97316 (Vibrant Orange)
• accent: #10B981 (Emerald Green)
• highlight: #F59E0B (Amber)
• bg: #F3F4F6 (Light Gray)
• surface: rgba(255, 255, 255, 0.8)
• text: #111827 (Dark Gray)
• text_muted: #6B7280 (Muted Gray)
• border: rgba(209, 213, 219, 0.5)

Signature Design Concept

The Steel-Bot homepage will feature an interactive lead map, where users can visually explore potential leads in a geographic format. Using @react-three/fiber and @react-three/drei, the map will allow users to zoom in and out, click on lead markers to view details, and drag to navigate different regions. The map will dynamically update as users input new criteria, providing a visually engaging and intuitive way to manage leads.

Interaction Model & Motion Direction

• Interaction Model: Parallax
  • The landing page will utilize a parallax scrolling effect, where background layers move at different speeds to create a sense of depth. This will enhance the storytelling aspect of the lead tracking process, making it visually appealing and engaging for users.

Non-Functional Requirements

• The system should support high availability and be able to handle up to 10,000 concurrent users.
• The application should ensure data security and user privacy, adhering to relevant data protection regulations.
• The system should provide a responsive design, ensuring usability across various devices and screen sizes.

Tech Stack

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

Assumptions and Constraints

• The application will primarily target individual users in the rental generator business.
• The system will be designed to operate in the PK timezone and support locale-specific defaults.
• The application will not initially support multi-language functionality.

Glossary

• Lead: A potential customer or client interested in the rental generator services.
• Parallax: A visual effect where background images move slower than foreground images, creating an illusion of depth.
• Responsive Design: An approach to web design that makes web pages render well on a variety of devices and window or screen sizes.