Calibration

Introduction

The Calibration project aims to develop a comprehensive website that includes role-based access control, session management, and automated testing to ensure a seamless user experience. This document outlines the system requirements necessary for building the website.

System Overview

The Calibration project is designed to provide users with a personalized experience by implementing role-based access control, ensuring that users only see the appropriate dashboard and tabs based on their permissions. The system will also handle session management effectively, ensuring users remain signed in and are redirected appropriately when sessions expire. Additionally, the project will include automated end-to-end tests to verify critical functionalities such as registration, sign-in, and sign-out processes.

Functional Requirements

• As a User, I should be able to see only the dashboard and tabs that correspond to my role and permissions.
• As an Admin, I should be able to manage user roles and permissions to control access to different parts of the website.
• As a User, I should receive email notifications for important updates and actions.
• As a User, I should be able to attach documents and fetch data from them without errors.
• As a User, I should be able to view my service history without issues.
• As a User, I should experience session timeout and refresh-token handling to stay signed in and be redirected correctly when the session expires.
• As a Developer, I should have automated end-to-end tests to verify that registration, sign-out, and sign-in processes always land on the dashboard without any "Load failed" errors.

User Personas

• Admin: Responsible for managing user roles and permissions, ensuring that users have access to the appropriate sections of the website.
• User: General users who interact with the website, accessing dashboards, receiving notifications, and managing their documents and service history.

Core User Flows

• User logs in -> System checks role -> User is directed to the appropriate dashboard -> User accesses allowed tabs.
• Admin logs in -> Admin manages user roles and permissions -> Changes are saved and reflected in user access.
• User uploads a document -> System fetches data from the document -> User receives confirmation of successful upload.
• User session expires -> System handles refresh-token -> User is redirected to the login page -> User logs back in and is redirected to the dashboard.

Visuals Colors and Theme

• primary: #1E3A8A (Deep Blue)
• primary_light: #3B82F6 (Light Blue)
• secondary: #F97316 (Amber)
• accent: #10B981 (Emerald Green)
• highlight: #F59E0B (Gold)
• bg: #F3F4F6 (Light Gray)
• surface: rgba(255, 255, 255, 0.8)
• text: #111827 (Dark Gray)
• text_muted: #6B7280 (Muted Gray)
• border: rgba(209, 213, 219, 0.2)

Signature Design Concept

The homepage of the Calibration website will feature an interactive galaxy map where each star represents a feature or section of the website. Users can click on a star to open a task card, drag to rotate the cluster, and hover to highlight connections between features. This concept will be brought to life using @react-three/fiber for 3D rendering and gsap for smooth animations and transitions. The galaxy map will provide an engaging and memorable first impression, encouraging users to explore the website's functionalities.

Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, creating a layered depth effect as users scroll through the page. Decorative elements such as atmospheric blobs and distant shapes will translate at different speeds, while the main content remains in the normal flow. This approach will provide a visually rich and immersive experience, ideal for storytelling and engaging users from the first interaction.

Non-Functional Requirements

• The system must ensure high availability and reliability, with a target uptime of 99.9%.
• The website should be optimized for performance, with page load times under 3 seconds.
• Security measures must be in place to protect user data and ensure secure access control.

Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB
• AI Models: Not applicable
• AI Tools: Not applicable
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The website will primarily serve users in India, considering locale-specific defaults such as currency (INR) and timezone (IST).
• The system must support multiple user roles with varying levels of access and permissions.
• Email notifications must be reliable and delivered promptly to users.

Glossary

• Role-Based Access Control (RBAC): A method of regulating access to computer or network resources based on the roles of individual users within an enterprise.
• Session Timeout: A security feature that automatically logs out a user after a period of inactivity.
• Refresh-Token: A token used to obtain a new access token without requiring the user to log in again.