System Requirements Document (SRD)

Project Name: glacial-dormitory

1. Introduction

The glacial-dormitory project aims to create a user-friendly website that helps students and working professionals find budget-friendly dormitories across major cities in India. By leveraging free APIs to fetch real-time data, the platform ensures accurate and up-to-date listings. The website will feature advanced filtering options, allowing users to search by city, price range, and amenities. Additionally, users will have the flexibility to either book accommodations directly through the platform or connect with property owners offline.

This document outlines the system requirements for the glacial-dormitory project, ensuring clarity and alignment with the goals set by Vinay Kandula.

2. System Overview

The glacial-dormitory system will serve as a centralized platform for discovering affordable dormitory accommodations in India. It will cater to two primary user groups: students and working professionals. The system will integrate free APIs to fetch real-time data on dormitory availability, pricing, and amenities.

Key features include:

• Advanced filtering options (city, price range, amenities).
• Dual booking options (online booking or offline contact).
• A responsive and intuitive user interface tailored for both desktop and mobile users.
• Real-time data updates using free APIs to ensure reliability and accuracy.

The platform will prioritize affordability, convenience, and user experience, making it a go-to solution for budget-conscious individuals seeking accommodations in major Indian cities.

3. Functional Requirements

As a User:

• I should be able to search for dormitories by city.
• I should be able to filter results by price range.
• I should be able to filter results by amenities (e.g., Wi-Fi, meals, laundry).
• I should be able to view detailed information about a dormitory, including photos, pricing, and amenities.
• I should be able to book a dormitory online through the platform.
• I should be able to view contact information for offline booking.

As an Admin:

• I should be able to manage dormitory listings, including adding, editing, and removing entries.
• I should be able to monitor user activity and bookings.
• I should be able to integrate and manage API connections for fetching real-time data.

4. User Personas

1. Student

• Description: College or university student looking for affordable accommodations near their institution.
• Goals: Find a budget-friendly dormitory with essential amenities like Wi-Fi and meals.
• Pain Points: Limited budget, lack of time to search extensively.

2. Working Professional

• Description: Young professional relocating to a new city for work.
• Goals: Find a comfortable and affordable dormitory with amenities like laundry and meals.
• Pain Points: Balancing affordability with comfort and convenience.

3. Admin

• Description: Platform administrator responsible for managing listings and ensuring data accuracy.
• Goals: Maintain an up-to-date and reliable database of dormitories.
• Pain Points: Ensuring seamless API integration and managing user activity.

5. Visuals Colors and Theme

Unique Color Palette for glacial-dormitory:

• Primary: #1A73E8 (Vibrant Blue for trust and reliability)
• Primary Light: #D2E3FC (Soft Blue for hover states and secondary UI)
• Secondary: #FF6F61 (Coral for emphasis and headlines)
• Accent: #FFD700 (Golden Yellow for CTAs and active states)
• Highlight: #FFB74D (Warm Amber for hover states and notifications)
• Background (bg): #F5F5F5 (Light Gray for page background)
• Surface: rgba(255, 255, 255, 0.9) (White for cards and panels)
• Text: #212121 (Dark Gray for primary text)
• Text Muted: #757575 (Muted Gray for secondary text and labels)
• Border: rgba(0, 0, 0, 0.1) (Subtle Black for borders)

6. Signature Design Concept

Concept: "Interactive City Map Explorer"

The homepage will feature an interactive map of India with major cities highlighted. Users can hover over a city to see a quick preview of available dormitories, including the number of listings and average price range. Clicking on a city will zoom in and display a detailed view with dormitory listings, filters, and options to book or contact.

Key Features:

• Hover Interaction: Cities light up with a glowing effect when hovered over.
• Zoom Animation: Smooth zoom-in effect when a city is clicked, powered by @react-three/fiber for 3D map rendering.
• Dynamic Data: Real-time dormitory data displayed as pins on the map, fetched via APIs.
• Micro-Interactions: Filters and buttons will have spring animations using framer-motion.

This design ensures a visually engaging and interactive experience, making the platform memorable and user-friendly.

7. Interaction Model & Motion Direction

Landing Page Interaction Model: Parallax

The landing page will use a parallax interaction model, creating a layered depth effect as users scroll. The interactive city map will be the centerpiece, with decorative elements like floating icons and subtle animations enhancing the experience.

Internal Pages Interaction Model: Animated

Internal pages (e.g., search results, booking, contact) will feature moderate animations, such as scroll-triggered reveals and hover transitions, for a polished and professional look.

8. Non-Functional Requirements

• Performance: The website should load within 3 seconds on a standard 4G connection.
• Scalability: The system should handle up to 10,000 concurrent users.
• Reliability: API integrations must ensure 99.9% uptime for real-time data fetching.
• Security: User data and transactions must be encrypted using SSL/TLS.
• Accessibility: The platform must comply with WCAG 2.1 Level AA standards.

9. Tech Stack

Frontend

• React for Web

Backend

• Python
• FastAPI

Database

• MySQL (with Alembic for migrations)

APIs

• Free APIs for dormitory data (e.g., city-based accommodation APIs)

AI Tools

• GPT 5.4 for user-friendly responses
• Litellm for LLM routing

Orchestration

• Docker for local orchestration
• Kubernetes for server-side orchestration

10. Assumptions and Constraints

• Free APIs will provide sufficient data for dormitory listings across major Indian cities.
• The platform will initially target users in India, with potential for future expansion.
• Users will have access to stable internet connections to interact with the platform.

11. Glossary

• Dormitory: A shared living space, typically affordable, catering to students and working professionals.
• API: Application Programming Interface, used for fetching real-time data.
• WCAG: Web Content Accessibility Guidelines, ensuring accessibility for users with disabilities.
• SSL/TLS: Secure Sockets Layer/Transport Layer Security, protocols for encrypting data.