ocean-badiyayaar System Requirements Document

1. Introduction

The "ocean-badiyayaar" project is focused on developing a personalized/custom gifts D2C (Direct-to-Consumer) store in India. This platform will offer a variety of customizable products such as mugs, t-shirts, and phone cases. The goal is to provide a seamless and engaging shopping experience for customers looking to purchase personalized gifts.

2. System Overview

The ocean-badiyayaar platform will serve as an online marketplace where users can customize and purchase gifts. The system will support various customization options, allowing users to personalize products according to their preferences. The platform will cater to the Indian market, ensuring that all functionalities and features are tailored to meet local needs and preferences.

3. Functional Requirements as Story Points

• As a User, I should be able to browse a catalog of customizable products such as mugs, t-shirts, and phone cases.
• As a User, I should be able to select a product and customize it with text, images, or designs.
• As a User, I should be able to preview my customized product before purchasing.
• As a User, I should be able to add customized products to my shopping cart.
• As a User, I should be able to securely checkout and make payments in INR.
• As a User, I should be able to track my order status after purchase.
• As an Admin, I should be able to manage product listings and customization options.
• As an Admin, I should be able to view and manage customer orders.
• As an Admin, I should be able to update the inventory and pricing of products.

4. User Personas

• User: A customer looking to purchase personalized gifts. They value customization options and a smooth shopping experience.
• Admin: A platform manager responsible for overseeing product listings, managing orders, and ensuring the platform runs smoothly.

5. Core User Flows

• User browses catalog -> selects product -> customizes product -> previews customization -> adds to cart -> checks out -> receives order confirmation -> tracks order.
• Admin logs in -> manages product listings -> updates inventory -> views customer orders -> processes orders.

6. Visuals Colors and Theme

• primary: #FF5733 (a vibrant orange to reflect creativity and energy)
• primary_light: #FF8A66 (a lighter tint of the primary color for hover states)
• secondary: #0056b3 (a deep blue for contrast and professionalism)
• accent: #FFC300 (a bright yellow for call-to-action elements)
• highlight: #C70039 (a bold red for notifications and active states)
• bg: #FFFFFF (a clean white background for clarity)
• surface: #F0F0F0 (a light grey for cards and panels)
• text: #333333 (a dark grey for primary text)
• text_muted: #777777 (a softer grey for secondary text)
• border: #DDDDDD (a subtle grey for borders)

7. Signature Design Concept

The homepage of ocean-badiyayaar will feature an interactive "Gift Customization Carousel." This carousel will allow users to see a rotating display of customizable products. Each product will animate with a 3D flip effect, showcasing different customization options as users hover over them. Users can click on a product to start customizing it directly from the carousel. This engaging feature will be built using @react-three/fiber for 3D effects and motion/react for smooth transitions.

Landing Hero Motion Brief

The landing hero will depict a vibrant scene where a plain mug, t-shirt, and phone case are transformed through user interaction. As users scroll, the products will animate from blank canvases to fully customized items, showcasing the personalization process. This will be achieved using motion/react for animations and CSS for styling. The animation will loop every 10 seconds, highlighting the transformation from input (plain product) to outcome (customized gift).

8. Interaction Model & Motion Direction

• Intended Interaction Model: Animated
  • The landing page will feature moderate scroll-triggered reveals and hover transitions. Interactive elements will have spring physics to enhance user engagement.
• Internal Pages: Static
  • For product pages, checkout, and user profiles, a static interaction model will be used to prioritize clarity and usability.

9. Non-Functional Requirements

• The platform must support high availability and scalability to handle peak shopping periods.
• The system should ensure data security and privacy for all user transactions.
• The website must be optimized for both desktop and mobile devices.

10. Tech Stack

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

11. Assumptions and Constraints

• The platform will primarily target the Indian market, with all transactions conducted in INR.
• Customization options will be limited to the products specified (mugs, t-shirts, phone cases).
• The system will adhere to local regulations regarding e-commerce and data protection.

12. Glossary

• D2C: Direct-to-Consumer, a business model where products are sold directly to customers without intermediaries.
• INR: Indian Rupee, the currency used in India.
• Customization: The process of modifying a product to suit individual preferences.