System Requirements Document (SRD)

Project Name: PropPilot

1. Introduction

The PropPilot project aims to create a modern, beginner-friendly prop firm comparison platform tailored for forex, futures, and crypto traders. Designed with simplicity and scalability in mind, this website will provide users with an intuitive interface to explore, compare, and review prop firms, while offering admins a clean and secure way to manage firm data and affiliate links.

Aditya Navale, based in India, envisions a premium fintech-style website that is easy to edit, lightweight, and visually appealing. This document outlines the system requirements necessary to achieve this vision.

2. System Overview

The PropPilot will serve as a centralized hub for traders to discover and compare prop firms. Key features include responsive firm listings, live search and filters, category tabs, a comparison system, user reviews, and affiliate link tracking. Admins will have exclusive access to an admin panel for managing firm data, while users can interact with the website seamlessly without requiring technical expertise.

The system will leverage Firebase for authentication and database management, ensuring secure and scalable data handling. The frontend will be built using simple HTML/CSS/JavaScript or React, depending on the need for clean and modular code. Deployment will be optimized for Vercel, ensuring fast and reliable performance.

3. Functional Requirements

User Stories:

Prop Firm Listings:

• As a User, I should be able to view prop firms displayed in responsive cards, each showing the firm's name, price, profit split, max drawdown, and a "Buy Now" button that opens an affiliate link in a new tab.

Search & Filters:

• As a User, I should be able to use a live search bar to find firms by name.
• As a User, I should be able to filter firms by drawdown, profit split, and price.

Category Tabs:

• As a User, I should see three main tabs at the top: FOREX, FUTURES, and CRYPTO (with a "NEW" badge).
• As a User, I should be able to switch tabs to dynamically filter firms by category.

Compare System:

• As a User, I should be able to select multiple firms and view them in a comparison table.

Review System:

• As a User, I should be able to post reviews under firms, which are auto-published without approval.

Authentication:

• As a User, I should be able to sign up and log in using email/password via Firebase Authentication.

Admin Panel:

• As an Admin, I should be able to add new firms, edit existing firms, delete firms, and manage affiliate links.
• As an Admin, I should have exclusive access to the admin panel, restricted to admin users only.

Affiliate System:

• As a User, I should be able to click on affiliate links to visit external firm pages.
• As the System, I should track the total number of affiliate clicks per firm without storing user data or timestamps.

Easy Edit System:

• As an Admin, I should be able to edit firm data, button text, colors, and affiliate links easily via a simple JSON array or Firebase collection.

Selective SRD Regeneration:

• As a User, I should be able to trigger selective re-generation of specific SRD sections to update requirements dynamically.

4. User Personas

Admin:

• Description: Admins are responsible for managing firm data, affiliate links, and overall website content.
• Key Actions: Add/edit/delete firms, manage affiliate links, and access the admin panel.

User:

• Description: Users are traders exploring prop firms for forex, futures, and crypto trading.
• Key Actions: View firm listings, search/filter firms, compare firms, post reviews, and click affiliate links.

5. Visuals Colors and Theme

Color Palette:

• Background: #0b1220
• Surface: #1e293b
• Text: #ffffff (white) and #94a3b8 (gray)
• Accent: #2563eb (blue)
• Muted Tones: #3b82f6 (lighter blue)

Theme Style:

• UI Style: Modern card-based layout with glassmorphism effects (blur + transparency), soft shadows, and subtle borders.
• Hover Effects: Smooth scaling and glowing transitions.
• Buttons: Blue gradient (#2563eb → #3b82f6) with optional purple/pink glow highlights.

6. Signature Design Concept

Concept: Interactive Prop Firm Galaxy

The homepage will feature an interactive galaxy map, where each star represents a prop firm. Users can hover over stars to reveal firm details in a glowing tooltip. Clicking on a star will zoom into a dynamic card view of the firm, complete with its name, price, profit split, max drawdown, and "Buy Now" button.

Key Features:

• Animations: Stars twinkle subtly, and the galaxy rotates slowly for a mesmerizing effect.
• Transitions: Smooth zoom-in/out animations when interacting with stars.
• Color Shifts: The galaxy background subtly changes hues based on the selected category tab (FOREX: blue, FUTURES: green, CRYPTO: purple).
• Micro-Interactions: Hovering over stars triggers a soft glow and tooltip reveal.

This bold and unforgettable design will captivate users and make the website stand out as a premium fintech product.

7. Non-Functional Requirements

• Performance: Ensure fast loading times and lightweight code.
• Scalability: Support future additions like review moderation and advanced affiliate tracking.
• Security: Restrict admin panel access to authenticated admin users only.
• Responsiveness: Fully optimize for mobile and desktop devices.
• SEO: Implement SEO-friendly structure for better search engine visibility.

8. Tech Stack

Frontend:

• HTML, CSS, JavaScript (preferred for simplicity) OR React (if clean and modular).

Backend:

• Firebase (Firestore for database + Authentication).

Deployment:

• Vercel for hosting.

9. Assumptions and Constraints

• Admin panel access will be restricted to authenticated admin users only.
• Reviews will be auto-published without moderation initially.
• Affiliate tracking will count total clicks per firm without storing user-specific data or timestamps.
• The website must remain beginner-friendly and easy to edit post-deployment.
• Selective SRD regeneration will allow dynamic updates to specific sections without requiring a full document rewrite.

10. Glossary

• Prop Firm: A company that provides traders with capital to trade, typically in exchange for a profit split.
• Affiliate Link: A unique URL that tracks clicks and redirects users to external firm pages.
• Glassmorphism: A design style featuring transparency, blur effects, and soft shadows.
• Firebase: A cloud-based platform for database management and authentication.
• Vercel: A deployment platform optimized for frontend applications.
• Selective SRD Regeneration: A feature allowing specific sections of the SRD to be updated dynamically based on user input.