Marine-Discounts System Requirements Document

Introduction

The purpose of this document is to outline the system requirements for the "marine-discounts" project. This project aims to create a platform similar to Unidays, but specifically tailored to offer discounts and deals for security guards. The platform will include user authentication and verification to ensure that only verified security personnel can access the exclusive deals.

System Overview

The "marine-discounts" platform will serve as a dedicated online space where security guards can access exclusive discounts and offers. The system will include features such as user registration, authentication, and verification, along with a comprehensive listing of available discounts. The platform will prioritize security and user privacy, ensuring that only verified users can access the deals.

Functional Requirements

• As a Security Guard, I should be able to register on the platform using my professional credentials.
• As a Security Guard, I should be able to log in to the platform securely.
• As a Security Guard, I should be able to verify my identity to access exclusive discounts.
• As a Security Guard, I should be able to browse available discounts and offers.
• As an Admin, I should be able to manage user accounts and verify user credentials.
• As an Admin, I should be able to add, update, or remove discount listings.

User Personas

• Security Guard: The primary user who will access the platform to find and utilize discounts.
• Admin: The user responsible for managing the platform, verifying user credentials, and maintaining the discount listings.

Visuals Colors and Theme

• primary: #1A3D6D (Deep Marine Blue)
• primary_light: #4A6FA1 (Light Marine Blue)
• secondary: #E63946 (Crimson Red)
• accent: #F4A261 (Vibrant Coral)
• highlight: #FFB703 (Warm Amber)
• bg: #F1FAEE (Soft White)
• surface: rgba(255, 255, 255, 0.9) (Translucent White)
• text: #1D3557 (Dark Navy)
• text_muted: #A8DADC (Muted Aqua)
• border: rgba(29, 53, 87, 0.2) (Subtle Navy)

Signature Design Concept

The homepage of "marine-discounts" will feature an interactive "Security Guard's Journey" theme. Users will navigate through a virtual cityscape where each building represents a different category of discounts. As users hover over a building, it will animate with a spotlight effect, revealing the types of discounts available within. Clicking on a building will transition the user into a detailed view of the available offers. This concept will be brought to life using @react-three/fiber for 3D interactions and gsap for smooth animations and transitions.

Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, creating a layered depth effect as users scroll through the page. Decorative elements such as cityscape silhouettes and atmospheric lighting will move at different speeds, enhancing the sense of immersion. The content will scroll naturally, with interactive elements revealing themselves through scroll-triggered animations. Internal pages will maintain a "static" model for clarity and ease of use.

Non-Functional Requirements

• The system must ensure data privacy and security for all user information.
• The platform should be responsive and accessible on both desktop and mobile devices.
• The system should handle concurrent user sessions efficiently without performance degradation.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: GPT 5.4 for user-friendly responses
• Local Orchestration: Docker, docker-compose

Assumptions and Constraints

• The platform will initially target security guards in India, with potential expansion to other regions.
• User verification will rely on professional credentials provided by security personnel.
• The system must comply with local data protection regulations.

Glossary

• User Authentication: The process of verifying the identity of a user attempting to access the system.
• Discount Listings: A collection of offers and deals available to verified users.
• Parallax: A design technique that creates an illusion of depth by moving background images slower than foreground images as the user scrolls.

This document outlines the foundational requirements and design concepts for the "marine-discounts" project, ensuring a focused and engaging platform for security guards seeking exclusive discounts.