City Palace System Requirements Document

Introduction

The City Palace project aims to develop an application that allows hotel management to track guest visits and maintain customer data efficiently. This document outlines the system requirements for the City Palace project, ensuring a comprehensive understanding of the functionalities and features needed.

System Overview

The City Palace application will serve as a comprehensive tool for hotel management to monitor guest visits, store customer data, and provide data analytics. The system will ensure secure storage of customer information, including ID card pictures, and offer insightful analytics to enhance decision-making processes.

Functional Requirements as Story Points

• As a Hotel Manager, I should be able to track guest visits to the hotel.
• As a Hotel Manager, I should be able to store customer data securely, including ID card pictures.
• As a Hotel Manager, I should be able to view data analytics to gain insights into guest patterns and preferences.

User Personas

• Hotel Manager: Responsible for overseeing hotel operations and utilizing the application to track guest visits and analyze customer data.
• Receptionist: Assists in entering guest information and managing check-ins and check-outs.
• IT Administrator: Ensures the application runs smoothly and securely, managing data storage and access.

Core User Flows

• Guest checks in -> Receptionist enters guest details and ID card picture -> Data is stored securely -> Hotel Manager accesses data analytics for insights.
• Hotel Manager reviews guest visit data -> Analyzes trends and patterns -> Makes informed decisions to improve guest experience.

Visuals Colors and Theme

• primary: #2C3E50 (Dark Blue)
• primary_light: #34495E (Light Blue)
• secondary: #ECF0F1 (Light Gray)
• accent: #E74C3C (Red)
• highlight: #3498DB (Bright Blue)
• bg: #FFFFFF (White)
• surface: #BDC3C7 (Silver)
• text: #2C3E50 (Dark Blue)
• text_muted: #7F8C8D (Gray)
• border: #D5D8DC (Light Gray)

Signature Design Concept

The City Palace application will feature an interactive "Guest Journey Map" on the home page. This map will visually represent the flow of guests through the hotel, from check-in to check-out, using animated paths and icons. Users can click on different stages of the journey to view detailed analytics and guest data. The map will be dynamic, with paths lighting up as guests move through the hotel. This concept will be implemented using motion/react for smooth animations and transitions.

Landing Hero Motion Brief

The landing page will feature a continuous loop animation of a guest's journey through the hotel. The animation will start with a guest arriving at the hotel, checking in, and moving through various hotel amenities. Each stage will transform to show data points and analytics, highlighting the guest's experience and preferences. The animation will be built using CSS and motion/react, ensuring a seamless and engaging user experience.

Interaction Model & Motion Direction

• Interaction Model: Animated
• The landing page will feature moderate scroll-triggered reveals and hover transitions, providing a polished and interactive experience. The animation will focus on the guest's journey and data transformation, ensuring clarity and engagement.

Non-Functional Requirements

• The system must ensure data security and privacy, especially concerning ID card pictures.
• The application should be scalable to accommodate increasing data and user load.
• The system should provide real-time data analytics with minimal latency.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• Local Orchestration: Docker, docker-compose

Assumptions and Constraints

• The application will primarily be used by hotel staff in India, considering local data privacy regulations.
• The system will operate in the IST timezone.
• The application must support both English and Hindi languages for user interface and data entry.

Glossary

• Guest Journey Map: A visual representation of a guest's experience through the hotel.
• Data Analytics: The process of analyzing data to gain insights and make informed decisions.
• ID Card Picture: A digital image of a guest's identification card stored in the system for verification purposes.