System Requirements Document (SRD)

teal-project

1. Introduction

The teal-project is a general marketplace application inspired by OffDeal.io. It aims to provide users with a platform to discover curated deals across various categories while enabling businesses to list their offers. The app is designed to cater to a diverse audience in India (IN), ensuring a seamless experience for both users and vendors.

This document outlines the system requirements for the teal-project, including functional and non-functional requirements, user personas, design concepts, and technical specifications.

2. System Overview

The teal-project is designed to be a versatile and user-friendly platform that connects users with the best deals available in the market. The system will support:

• User accounts for personalized experiences.
• Deal notifications to keep users informed about the latest offers.
• Vendor management tools for businesses to list and manage their deals.

The platform will be accessible via web and mobile applications, ensuring a broad reach and convenience for users in India. The system will prioritize scalability, security, and performance to handle a growing user base and diverse deal categories.

3. Functional Requirements

User Stories:

• As a User, I should be able to create an account and log in.
• As a User, I should be able to browse deals by category.
• As a User, I should be able to search for specific deals.
• As a User, I should be able to save deals to a favorites list.
• As a User, I should receive notifications about new deals or expiring offers.
• As a Vendor, I should be able to create an account and log in.
• As a Vendor, I should be able to list new deals with details like price, category, and expiration date.
• As a Vendor, I should be able to manage my listed deals (edit, delete, or update).
• As an Admin, I should be able to monitor and approve vendor accounts.
• As an Admin, I should be able to moderate deals to ensure quality and compliance.

4. User Personas

1. User

• Description: General users who browse and save deals.
• Goals: Discover the best deals, save money, and receive timely notifications.
• Pain Points: Missing out on deals, difficulty in finding relevant offers.

2. Vendor

• Description: Businesses or individuals listing deals on the platform.
• Goals: Reach a wider audience, manage deals efficiently, and increase sales.
• Pain Points: Difficulty in managing multiple deals, lack of visibility.

3. Admin

• Description: Platform administrators responsible for maintaining quality and compliance.
• Goals: Ensure a smooth user experience, monitor vendor activities, and maintain platform integrity.
• Pain Points: Managing a large volume of vendor accounts and deals.

5. Visuals Colors and Theme

Color Palette:

• Background: #E8F5E9 (soft green for a fresh, inviting look)
• Surface: #FFFFFF (pure white for cards and containers)
• Text: #2E2E2E (dark charcoal gray for readability)
• Accent: #00A676 (vivid teal for buttons and highlights)
• Muted: #B2DFDB (light teal for secondary elements)

6. Signature Design Concept

The teal-project will feature a "Living Deal Carousel" on the homepage.

Concept Details:

• Visual: The homepage will showcase a dynamic carousel of deals, where each deal card appears as a floating 3D tile.
• Interaction:
  • Users can swipe or scroll horizontally through the carousel.
  • Hovering over a deal card will cause it to "tilt" slightly, revealing additional details like the discount percentage and expiration date.
  • Clicking on a card will open a detailed deal page with a smooth zoom-in animation.
• Animation:
  • The carousel will have a continuous, smooth scrolling effect, with deal cards gently bouncing as they come into focus.
  • When a user interacts with a card, a ripple effect will highlight the action.
• Color Shifts: The carousel background will transition between soft gradients of teal and green, creating a calming yet engaging visual experience.
• Micro-interactions:
  • Buttons will have a glowing effect when hovered over.
  • Notifications will slide in from the bottom-left corner with a fade-in animation.

This design will make the teal-project visually stunning and interactive, drawing users into the platform and encouraging them to explore deals further.

7. Non-Functional Requirements

• Performance: The system should handle up to 15,000 concurrent users with minimal latency.
• Scalability: The platform should support the addition of new categories and features without significant downtime.
• Security: User data must be encrypted, and the system should comply with GDPR and Indian data protection laws.
• Availability: The platform should have 99.9% uptime.
• Localization: The app should support Indian languages like Hindi, Marathi, Gujarati, and Tamil in addition to English.

8. Tech Stack

Frontend:

• React for Web
• React Native for Mobile App

Backend:

• Python
• FastAPI

Database:

• MySQL (with Alembic for migrations)

AI Models:

• GPT 5.4 for user-friendly responses
• Claude 4.6 Opas for coding-related queries

AI Tools:

• Litellm for LLM Routing
• Langchain

Orchestration:

• Docker (local)
• Kubernetes (server-side)

9. Assumptions and Constraints

• Assumptions:

  • Users will have access to smartphones or computers with internet connectivity.
  • Vendors will provide accurate and up-to-date deal information.

• Constraints:

  • The platform must comply with Indian e-commerce regulations.
  • Initial development will focus on the Indian market, with potential for global expansion later.

10. Glossary

• User: An individual browsing and saving deals on the platform.
• Vendor: A business or individual listing deals on the platform.
• Admin: A platform administrator responsible for moderation and quality control.
• Deal: A promotional offer listed by a vendor.
• Living Deal Carousel: An interactive carousel feature showcasing deals dynamically.