fileDescriptions.json

{
	"client/components.json": "Configuration file for UI component library, defining schema, styling options, and resource paths.",
	"client/eslint.config.js": "ESLint configuration file for TypeScript and React, including plugins and custom rules.",
	"client/index.html": "Main HTML entry point with root div for React mounting and main.tsx script.",
	"client/package.json": "Client configuration with dependencies, scripts, and metadata.",
	"client/postcss.config.js": "PostCSS configuration with tailwindcss and autoprefixer plugins.",
	"client/src/api/api.ts": "This file configures an Axios instance request authentication via access tokens, and automatic token refresh on authentication failures.",
	"client/src/api/auth.ts": "API utility functions for user authentication. Exports function login, register and logout.",
	"client/src/App.css": "Main application styles including root layout and animations.",
	"client/src/App.tsx": "Main React component with the routing structure - this file is very important as it shows which pages are opened on which routes.",
	"client/src/components/Footer.tsx": "Footer component with privacy and terms links.",
	"client/src/components/Header.tsx": "Header component with navigation menu.",
	"client/src/components/Layout.tsx": "Layout component with header, main content, and footer.",
	"client/src/components/ProtectedRoute.tsx": "Protected route component for authenticated user access control.",
	"client/src/components/ui/accordion.tsx": "Shadcn Accordion component. Exports Accordion, AccordionItem, AccordionButton, and AccordionPanel.",
	"client/src/components/ui/alert-dialog.tsx": "Shadcn Alert Dialog component. Exports   AlertDialog, AlertDialogPortal, AlertDialogOverlay, AlertDialogTrigger, AlertDialogContent, AlertDialogHeader, AlertDialogFooter, AlertDialogTitle, AlertDialogDescription, AlertDialogAction, AlertDialogCancel.",
	"client/src/components/ui/alert.tsx": "Shadcn Alert component. Exports Alert, AlertTitle, AlertDescription.",
	"client/src/components/ui/aspect-ratio.tsx": "Shadcn Aspect Ratio component. Exports AspectRatio.",
	"client/src/components/ui/avatar.tsx": "Shadcn Avatar component. Exports Avatar, AvatarImage, AvatarFallback.",
	"client/src/components/ui/badge.tsx": "Shadcn Badge component. Exports Badge, badgeVariants.",
	"client/src/components/ui/breadcrumb.tsx": "Shadcn Breadcrumb component. Exports Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis.",
	"client/src/components/ui/button.tsx": "Shadcn Button component. Exports Button, buttonVariants.",
	"client/src/components/ui/calendar.tsx": "Shadcn Calendar component. Exports Calendar.",
	"client/src/components/ui/card.tsx": "Shadcn Card component. Exports Card, CardHeader, CardFooter, CardTitle, CardDescription, CardContent.",
	"client/src/components/ui/carousel.tsx": "Shadcn Carousel component. Exports type CarouselApi, Carousel, CarouselContent, CarouselItem, CarouselPrevious, CarouselNext.",
	"client/src/components/ui/chart.tsx": "Shadcn Chart component. Exports ChartContainer, ChartTooltip, ChartTooltipContent, ChartLegend, ChartLegendContent, ChartStyle.",
	"client/src/components/ui/checkbox.tsx": "Shadcn Checkbox component. Exports Checkbox.",
	"client/src/components/ui/collapsible.tsx": "Shadcn Collapsible component. Exports Collapsible, CollapsibleTrigger, CollapsibleContent.",
	"client/src/components/ui/command.tsx": "Shadcn Command component. Exports Command, CommandDialog, CommandInput, CommandList, CommandEmpty, CommandGroup, CommandItem, CommandShortcut, CommandSeparator.",
	"client/src/components/ui/context-menu.tsx": "Shadcn Context Menu component. Exports ContextMenu, ContextMenuTrigger, ContextMenuContent, ContextMenuItem, ContextMenuCheckboxItem, ContextMenuRadioItem, ContextMenuLabel, ContextMenuSeparator, ContextMenuShortcut, ContextMenuGroup, ContextMenuPortal, ContextMenuSub, ContextMenuSubContent, ContextMenuSubTrigger, ContextMenuRadioGroup.",
	"client/src/components/ui/dialog.tsx": "Shadcn Dialog component. Exports Dialog, DialogPortal, DialogOverlay, DialogClose, DialogTrigger, DialogContent, DialogHeader, DialogFooter, DialogTitle, DialogDescription.",
	"client/src/components/ui/drawer.tsx": "Shadcn Drawer component. Exports Drawer, DrawerPortal, DrawerOverlay, DrawerClose, DrawerTrigger, DrawerContent, DrawerHeader, DrawerFooter, DrawerTitle, DrawerDescription.",
	"client/src/components/ui/dropdown-menu.tsx": "Shadcn Dropdown Menu component. Exports DropdownMenu, DropdownMenuTrigger, DropdownMenuContent, DropdownMenuItem, DropdownMenuCheckboxItem, DropdownMenuRadioItem, DropdownMenuLabel, DropdownMenuSeparator, DropdownMenuShortcut, DropdownMenuGroup, DropdownMenuPortal, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuRadioGroup.",
	"client/src/components/ui/form.tsx": "Shadcn Form component. Exports useFormField, Form, FormField, FormLabel, FormItem, FormControl, FormDescription, FormMessage.",
	"client/src/components/ui/hover-card.tsx": "Shadcn Hover Card component. Exports HoverCard, HoverCardTrigger, HoverCardContent.",
	"client/src/components/ui/input-otp.tsx": "Shadcn Input OTP component. Exports InputOTP, InputOTPGroup, InputOTPSlot, InputOTPSeparator.",
	"client/src/components/ui/input.tsx": "Shadcn Input component. Exports Input.",
	"client/src/components/ui/label.tsx": "Shadcn Label component. Exports Label.",
	"client/src/components/ui/menubar.tsx": "Shadcn Menubar component. Exports Menubar, MenubarMenu, MenubarTrigger, MenubarContent, MenubarItem, MenubarSeparator, MenubarLabel, MenubarCheckboxItem, MenubarRadioGroup, MenubarRadioItem, MenubarPortal, MenubarSubContent, MenubarSubTrigger, MenubarGroup, MenubarSub, MenubarShortcut.",
	"client/src/components/ui/navigation-menu.tsx": "Shadcn Navigation Menu component. Exports navigationMenuTriggerStyle, NavigationMenu, NavigationMenuList, NavigationMenuItem, NavigationMenuContent, NavigationMenuTrigger, NavigationMenuLink, NavigationMenuIndicator, NavigationMenuViewport.",
	"client/src/components/ui/pagination.tsx": "Shadcn Pagination component. Exports Pagination, PaginationContent, PaginationEllipsis, PaginationItem, PaginationLink, PaginationNext, PaginationPrevious.",
	"client/src/components/ui/popover.tsx": "Shadcn Popover component. Exports Popover, PopoverTrigger, PopoverContent.",
	"client/src/components/ui/progress.tsx": "Shadcn Progress component. Exports Progress.",
	"client/src/components/ui/radio-group.tsx": "Shadcn Radio Group component. Exports RadioGroup, RadioGroupItem.",
	"client/src/components/ui/resizable.tsx": "Shadcn Resizable component. Exports ResizablePanelGroup, ResizablePanel, ResizableHandle.",
	"client/src/components/ui/scroll-area.tsx": "Shadcn Scroll Area component. Exports ScrollArea, ScrollBar.",
	"client/src/components/ui/select.tsx": "Shadcn Select component. Exports Select, SelectGroup, SelectValue, SelectTrigger, SelectContent, SelectLabel, SelectItem, SelectSeparator, SelectScrollUpButton, SelectScrollDownButton.",
	"client/src/components/ui/separator.tsx": "Shadcn Separator component. Exports Separator.",
	"client/src/components/ui/sheet.tsx": "Shadcn Sheet component. Exports Sheet, SheetPortal, SheetOverlay, SheetClose, SheetTrigger, SheetContent, SheetHeader, SheetFooter, SheetTitle, SheetDescription.",
	"client/src/components/ui/sidebar.tsx": "Shadcn Sidebar component. Exports Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupAction, SidebarGroupContent, SidebarGroupLabel, SidebarHeader, SidebarInput, SidebarInset, SidebarMenu, SidebarMenuAction, SidebarMenuBadge, SidebarMenuButton, SidebarMenuItem, SidebarMenuSkeleton, SidebarMenuSub, SidebarMenuSubButton, SidebarMenuSubItem, SidebarProvider, SidebarRail, SidebarSeparator, SidebarTrigger, useSidebar.",
	"client/src/components/ui/skeleton.tsx": "Shadcn Skeleton component. Exports Skeleton.",
	"client/src/components/ui/slider.tsx": "Shadcn Slider component. Exports Slider.",
	"client/src/components/ui/sonner.tsx": "Shadcn Sonner component. Exports Toaster.",
	"client/src/components/ui/switch.tsx": "Shadcn Switch component. Exports Switch.",
	"client/src/components/ui/table.tsx": "Shadcn Table component. Exports Table, TableBody, TableCell, TableFooter, TableHeader, TableHead, TableRow, TableCaption.",
	"client/src/components/ui/tabs.tsx": "Shadcn Tabs component. Exports Tabs, TabsList, TabsTrigger, TabsContent.",
	"client/src/components/ui/textarea.tsx": "Shadcn Textarea component. Exports Textarea.",
	"client/src/components/ui/theme-provider.tsx": "Theme provider component for managing and applying theme settings in a React application using context and hooks.",
	"client/src/components/ui/theme-toggle.tsx": "Theme toggle component for switching between light and dark modes. Exports ThemeToggle.",
	"client/src/components/ui/toast.tsx": "Shadcn Toast component. Exports type ToastProps, type ToastActionElement, ToastProvider, ToastViewport, Toast, ToastTitle, ToastDescription, ToastClose, ToastAction.",
	"client/src/components/ui/toaster.tsx": "Shadcn Toaster component. Exports Toaster.",
	"client/src/components/ui/toggle-group.tsx": "Shadcn Toggle Group component. Exports ToggleGroup, ToggleGroupItem.",
	"client/src/components/ui/toggle.tsx": "Shadcn Toggle component. Exports Toggle, toggleVariants.",
	"client/src/components/ui/tooltip.tsx": "Shadcn Tooltip component. Exports Tooltip, TooltipTrigger, TooltipContent, TooltipProvider.",
	"client/src/contexts/AuthContext.tsx": "Context provider for user authentication state management. Exports AuthProvider, useAuth.",
	"client/src/hooks/useMobile.tsx": "Custom hook for detecting mobile viewport.",
	"client/src/hooks/useToast.ts": "Custom hook for managing toast notifications.",
	"client/src/index.css": "Global styles with Tailwind CSS configuration and theme variables.",
	"client/src/lib/utils.ts": "Utility functions for class name management.",
	"client/src/pages/Login.tsx": "Login page component with form for user authentication.",
	"client/src/pages/Register.tsx": "Registration page component with form for user registration.",
	"client/src/main.tsx": "Application entry point with React root rendering.",
	"client/src/vite-env.d.ts": "TypeScript declarations for Vite environment.",
	"client/tsconfig.app.json": "TypeScript configuration for application code.",
	"client/tsconfig.json": "Main TypeScript configuration with project references.",
	"client/tsconfig.node.json": "TypeScript configuration for Node.js environment.",
	"client/vite.config.ts": "Vite build tool configuration with  server proxy configuration.",
	"client/tailwind.config.js": "Tailwind CSS configuration with theme customizations, including enabling dark mode, specifying the content files that Tailwind should scan for class names, and extending the default theme with custom values for border radius, colors, keyframes, and animations. The configuration also includes a plugin for animations, specifically 'tailwindcss-animate', which allows for additional animation utilities to be used in the project.",
	"server/.env": "This file is a configuration file in the form of a .env file. It contains environment variables used by the application, such as the port to listen on, the MongoDB database URL, and the session secret string.",
	"server/package.json": "Node.js server configuration defining project dependencies, scripts for development, build, and deployment, with TypeScript support and various utility packages for authentication, API interactions, and logging.",
	"package.json": "Project configuration with dependencies, scripts, and metadata.",
	".gitignore": "Git configuration to exclude files and directories from version control.",
	"fileDescriptions.json": "Centralized JSON file containing descriptive metadata for all project files, serving as a comprehensive documentation repository.",
	"server/routes/testRoutes.ts": "Express router for test management, providing CRUD endpoints with authentication middleware for creating, retrieving, updating, and deleting tests.",
	"server/routes/testSuiteRoutes.ts": "Express router for test suite management, providing CRUD endpoints for creating, retrieving, updating, and deleting test suites with authentication middleware.",
	"server/routes/userRoutes.ts": "Express router for user management, handling operations like listing users, fetching user details, deleting users, sending invitations, and managing user registration through invitation tokens.",
	"client/src/api/dashboard.ts": "API function for retrieving dashboard statistics, providing current release metrics, stale tests, and testing activity data with optional label filtering.",
	"client/src/api/releases.ts": "API utility functions for managing releases, including CRUD operations, test run creation, and retrieving release-related statistics and test information.",
	"client/src/api/settings.ts": "API utility functions for Linear integration settings, providing methods to retrieve, connect, and disconnect Linear account configurations.",
	"client/src/api/testSuites.ts": "API service functions for managing test suites, providing methods to retrieve, create, update, and delete test suite resources through HTTP requests.",
	"client/src/api/tests.ts": "API service functions for managing tests and labels, providing methods to retrieve, create, update, and delete tests, along with fetching available labels.",
	"client/src/api/users.ts": "API utility functions for user management, providing methods to fetch users, invite new users, delete users, verify invitations, and complete user registration through invitation tokens.",
	"client/src/components/LabelBadge.tsx": "Reusable React component rendering a customizable badge with dynamic color and label name based on a Label type.",
	"client/src/components/PriorityBadge.tsx": "Reusable React component that renders a color-coded priority badge with an icon, dynamically styling based on priority level (high, medium, low).",
	"client/src/components/Sidebar.tsx": "Responsive sidebar component for QA Manager application, rendering navigation links with dynamic active state and gradient styling using React Router and Lucide icons.",
	"client/src/components/StatusBadge.tsx": "Reusable React component for rendering status badges with dynamic styling and icons for release, test run, and user statuses, supporting different color schemes and visual representations.",
	"client/src/components/UserAvatar.tsx": "Reusable React component for rendering user avatars with customizable size, color, and optional name display, generating initials from user's first and last name.",
	"client/src/components/modals/DeleteConfirmDialog.tsx": "Reusable modal dialog component for confirming delete actions with customizable title, description, and confirmation handling.",
	"client/src/components/modals/InviteUserModal.tsx": "Modal component for inviting new users via email, with form validation, loading state, and toast notifications for successful or failed invitation attempts.",
	"client/src/components/modals/ReleaseModal.tsx": "Reusable modal component for creating and editing software releases, allowing users to specify name, description, status, and associated test suites with form validation and API integration.",
	"client/src/components/modals/TestModal.tsx": "Reusable modal component for creating and editing test cases with dynamic form fields, label management, step configuration, and validation logic.",
	"client/src/components/modals/TestRunModal.tsx": "Multi-step modal component for creating and documenting test runs, allowing users to select tests, execute test steps, and record detailed test results with optional defect and failure reporting.",
	"client/src/components/modals/TestSuiteModal.tsx": "Modal component for creating and editing test suites, allowing users to define name, description, assignee, and select multiple tests with search and filtering capabilities.",
	"client/src/pages/BlankPage.tsx": "Placeholder React component for displaying a \"Page Under Construction\" message with a navigation button to return home, dynamically showing the current unimplemented route path.",
	"client/src/pages/Dashboard.tsx": "Dashboard page rendering comprehensive testing metrics, displaying current release status, stale tests, and testing activity chart with interactive filtering by date range and labels.",
	"client/src/pages/RegisterInvite.tsx": "React component for handling user registration via invitation, verifying invitation token and allowing users to complete registration with email, name, and password.",
	"client/src/pages/ReleaseDetail.tsx": "Detailed React component for rendering release information, displaying test suite progress, test runs, and providing actions like creating test runs with dynamic status tracking and user interactions.",
	"client/src/pages/Releases.tsx": "Releases page component managing release tracking with search, filtering, creation, editing, and deletion functionality, displaying a table of releases with progress, status, and test run details.",
	"client/src/pages/Settings.tsx": "Settings page for Linear integration, managing workspace connection, OAuth authentication, and configuring default ticket settings for failed tests.",
	"client/src/pages/TestSuites.tsx": "React page component for managing test suites, providing search, creation, editing, and deletion functionality with a responsive grid layout and modal interactions.",
	"client/src/pages/Tests.tsx": "Tests page component managing test cases with filtering, search, create, edit, and delete functionality, rendering a dynamic table of tests with advanced UI interactions and state management.",
	"client/src/pages/Users.tsx": "User management page with table view, supporting user invitation, deletion, and displaying user details with status and avatar.",
	"client/src/types/index.ts": "TypeScript type definitions for core domain models in a test management application, including User, Test, TestSuite, Release, and supporting enums and interfaces for tracking testing workflows and project metadata.",
	"client/src/utils/avatarUtils.ts": "Avatar utility functions for generating user initials and deterministic color selection based on name input.",
	"client/src/utils/dateUtils.ts": "Date formatting utility functions using date-fns library, providing relative time, short date, and datetime formatting methods.",
	"server/eslint.config.js": "ESLint configuration for TypeScript and JavaScript files, setting recommended rules, global environments, and custom linting preferences for the server project.",
	"server/server.ts": "Express server configuration with comprehensive API route setup, database connection, middleware initialization, and error handling for a test management application.",
	"server/tsconfig.json": "TypeScript configuration file for server-side compilation, defining strict type checking, module resolution, and build output settings for Node.js environment.",
	"server/config/database.ts": "MongoDB connection utility that establishes and manages database connection with error handling, reconnection logic, and graceful shutdown mechanism.",
	"server/models/Label.ts": "Mongoose schema for label entities with name, color, and creation timestamp, supporting unique label creation with hex color validation.",
	"server/models/Test.ts": "Mongoose schema for Test model, defining structure for test cases with steps, labels, priority, assignee, and metadata tracking.",
	"server/models/TestSuite.ts": "Mongoose schema for TestSuite model, defining structure for test collections with name, description, assignee, tests, and automatic timestamp management.",
	"server/models/User.ts": "Mongoose User model defining schema with authentication details, roles, and user metadata, including email, password validation, and refresh token generation.",
	"server/models/init.ts": "Database initialization module for establishing MongoDB connection and importing all Mongoose model schemas for the application.",
	"server/routes/authRoutes.ts": "Express router handling authentication routes with login, registration, logout, token refresh, user profile retrieval, and password reset functionality.",
	"server/routes/index.ts": "Express router configuration handling root path and health check endpoints, providing welcome message and ping response.",
	"server/routes/labelRoutes.ts": "Express router for managing label-related API endpoints, providing functionality to retrieve all labels with authentication middleware and error handling.",
	"server/routes/middlewares/auth.ts": "Express middleware for JWT-based authentication and role-based access control, validating user tokens and enforcing role permissions for protected routes.",
	"server/scripts/seedData.ts": "Database seeding script for populating MongoDB with initial test data, creating users, labels, tests, and test suites with predefined sample data for development and testing purposes.",
	"server/services/labelService.ts": "Label service providing methods to retrieve, create, and manage labels with support for fetching all labels, creating unique labels, and batch label processing with automatic color generation.",
	"server/services/llmService.ts": "LLM service module for sending requests to OpenAI and Anthropic, with retry mechanism and error handling for generating AI responses.",
	"server/services/testService.ts": "Service class for managing test-related operations, providing methods to create, retrieve, update, and delete tests with label and assignee population.",
	"server/services/testSuiteService.ts": "Service layer for managing test suites with CRUD operations, providing methods to retrieve, create, update, and delete test suites with populated references and detailed error handling.",
	"server/services/userService.ts": "User management service with comprehensive methods for user authentication, creation, invitation, and registration, handling database interactions and password management.",
	"server/utils/auth.ts": "JWT token generation utility for user authentication, providing functions to create access and refresh tokens with configurable expiration periods.",
	"server/utils/password.ts": "Password utility functions for secure password hashing, validation, and format checking using bcrypt algorithm with methods to generate hash, compare passwords, and validate hash format.",
	"shared/eslint.config.js": "ESLint configuration for TypeScript and JavaScript projects, setting recommended rules, global settings, and custom linting preferences for the project.",
	"shared/index.ts": "Centralized export module for shared role configurations and user type definitions across the application.",
	"shared/package.json": "Package configuration for shared TypeScript module with build scripts, linting, and development utilities for a reusable library.",
	"shared/tsconfig.json": "TypeScript compiler configuration for shared library, setting strict type checking, module resolution, and build output options for TypeScript files.",
	"shared/config/roles.ts": "Role configuration module defining user role constants and type-safe role management utilities for application access control.",
	"shared/types/user.ts": "TypeScript type definition for User model, specifying structure and properties of user accounts in the application.",
	"server/models/Release.ts": "Mongoose schema for Release model, defining structure and validation for release tracking with status, test suites, and creator references.",
	"server/models/TestRun.ts": "Mongoose schema for tracking test run results, capturing test execution details, outcomes, associated release, executor, and optional defect or ticket information.",
	"server/routes/releaseRoutes.ts": "Express router for release management, handling CRUD operations, test runs, and release statistics with authentication middleware.",
	"server/routes/testRunRoutes.ts": "Express router handling test run operations with endpoints for retrieving, filtering, and deleting test runs, secured with user authentication middleware.",
	"server/scripts/seedReleases.ts": "Database seeding script for populating Release and TestRun models with sample data, creating multiple releases and associated test runs with varied statuses and execution details.",
	"server/services/releaseService.ts": "Service class for managing software releases, providing methods to create, retrieve, update, and delete releases, with additional functionality for fetching untested tests and generating release statistics.",
	"server/services/testRunService.ts": "Service for managing test runs, providing methods to create, retrieve, and delete test runs across releases, with optional Linear ticket integration for failed tests.",
	"server/models/LinearIntegration.ts": "Mongoose schema and model for storing Linear workspace integration details, tracking user tokens, workspace, team information, and default assignee settings.",
	"server/routes/linearRoutes.ts": "Express router handling Linear integration routes for user authentication, connection, disconnection, and OAuth callback with endpoints for retrieving settings, connecting/disconnecting accounts, and processing OAuth callbacks.",
	"server/services/linearService.ts": "Linear service for managing OAuth integration, issue creation, and team synchronization with Linear's GraphQL API, providing methods to connect, disconnect, and create issues for users.",
	"client/.env.local": "OAuth configuration file for Linear authentication, storing the client ID for frontend application.",
	"server/models/PasswordReset.ts": "Mongoose schema for password reset tokens, tracking user-specific reset requests with unique tokens, expiration, and usage status.",
	"server/models/UserInvitation.ts": "Mongoose schema for user invitation tracking, managing invitation tokens, status, expiration, and referencing the inviting user with automatic token generation and indexing.",
	"server/scripts/seedAdmin.ts": "Database seeding script for creating an initial admin user with predefined credentials, connecting to the database and setting up an admin account with full system access.",
	"server/services/emailService.ts": "Postmark-based email service for sending user invitation and password reset emails with configurable HTML and plain text templates.",
	"server/scripts/clearInvitations.ts": "Database cleanup script for deleting all pending user invitations, utilizing database initialization and UserInvitation model to remove invitation records.",
	"server/routes/dashboardRoutes.ts": "Express route handler for retrieving dashboard statistics, providing an endpoint to fetch current release, stale tests, and testing activity with optional filtering by label and date range.",
	"server/scripts/seedStaleTests.ts": "Database seeding script for creating predefined stale test cases with specific metadata, labels, and testing scenarios across different system components.",
	"server/services/dashboardService.ts": "Dashboard service providing comprehensive testing analytics, including current release statistics, stale test identification, and testing activity tracking with optional label-based filtering.",
	"LICENSE": "MIT License file defining usage terms and copyright for the QA Management System project, granting permissions for software use, modification, and distribution.",
	"README.md": "Comprehensive README for a QA Management System, detailing project overview, features, tech stack, installation instructions, project structure, authentication, database models, API endpoints, and contribution guidelines."
}