deep-website

byKrish Abinash

make the website

No preview

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement DocumentProposed change+13−3on v2
Page 1 of 7

System Requirements Document

Introduction

This document outlines the system requirements for the BIS IntelliGuide website frontend development project. The project involves designing, developing, and implementing a complete frontend website for the Smart India Hackathon project SIH26107, titled "AI-powered Intelligent Assistant for Indian Standards and BIS Services for Industries and Consumers." The existing backend is read-only and must not be modified.

This document outlines the system requirements for the deep-website project. The project involves designing, developing, and implementing a complete frontend website. The existing backend is read-only and must not be modified.

System Overview

The BIS IntelliGuide website will serve as an AI-powered intelligent assistant platform for Indian Standards and BIS services. It will provide users with the ability to discover, understand, and comply with Indian Standards through a professional, responsive, and accessible multi-page website. The frontend will connect to the existing backend APIs without any modifications to the backend.

The deep-website will serve as a platform for users to discover, understand, and comply with relevant standards and services. It will provide users with a professional, responsive, and accessible multi-page website. The frontend will connect to the existing backend APIs without any modifications to the backend.

Page 2 of 7

Functional Requirements

General Website Requirements

  • As a user, I want the website to be called "BIS IntelliGuide" with the main tagline "Your Intelligent Assistant for Indian Standards & BIS Services" and a secondary tagline "Find. Understand. Comply."
  • As a user, I want the website to have a professional design system with specified colors and fonts, avoiding excessive gradients and unnecessary effects.
  • As a user, I want the website to be responsive across desktop, laptop, tablet, and mobile devices.

make the website

Navigation and Structure

  • As a user, I want a main navigation containing Home, AI Assistant, Standards, Recommend, Document Analyzer, BIS Services, History, Saved Items, Help, and Profile.
  • As an administrator, I want access to an Admin Dashboard if supported by the backend.

Home Page

  • As a user, I want a premium homepage that communicates the purpose of BIS IntelliGuide with a central search/AI input and example prompts.
  • As a user, I want Quick Action cards and Popular Tasks sections for easy access to key functionalities.

AI Assistant

  • As a user, I want a dedicated AI Assistant page with a professional workspace layout, conversation history, and organized answer sections.
  • As a user, I want to interact with the AI Assistant using features like New Chat, conversation history management, and feedback options.
  • As a user, I want Knowledge-Grounded AI Responses to ensure the information provided is accurate and reliable.
  • As a user, I want Evidence-Based Answers to support the information provided by the AI Assistant.
Page 3 of 7

Standards

  • As a user, I want an "Explore Indian Standards" page with a search box and filters connected to the standards search API.
  • As a user, I want a Standard Details page displaying comprehensive information about each standard, including Standard Status, Products Covered, and Related Standards.
  • As a user, I want a Standard Comparison feature if supported by the backend.

Recommendations

  • As a user, I want a "Find the Right Standard" page connected to the recommendation API, displaying relevant recommendations based on Product Category, Intended Use, Manufacturing Process, and Target Market.

Document Analyzer

  • As a user, I want a Document Analyzer page with drag-and-drop and file picker functionality, displaying analysis results from the backend, including Detected Product, Detected Materials, Detected Specifications, Potential Standards, and Secure Document Analysis.

BIS Services

  • As a user, I want a BIS Services page displaying available services with real data from the backend, including Product Certification and Compulsory Certification.

History and Saved Items

  • As a user, I want a History page organizing past activities and a Saved Items feature using localStorage if persistent saving is not supported by the backend.

Authentication

  • As a user, I want professional Login, Register, Logout, and Profile pages using existing authentication APIs with form validation and error handling.
  • As a user, I want the system to never expose passwords, JWT secrets, API keys, LLM keys, or other private secrets.

Dark Mode and Accessibility

  • As a user, I want Light, Dark, and System themes with accessibility features like keyboard navigation, ARIA labels, accessible forms, and accessible dialogs.
Page 4 of 7

Language and Voice

  • As a user, I want a multilingual-ready frontend with a language selector and voice input support where applicable.

Admin

  • As an administrator, I want a professional Admin Dashboard using existing admin APIs if supported by the backend.

UX, Loading, and Errors

  • As a user, I want professional loading indicators, error messages, and toast notifications for a seamless experience.

Help, About, and Footer

  • As a user, I want a Help/FAQ section, an About page, and a comprehensive footer with relevant links and compliance notices.

Compliance Warning

  • As a user, I want a reusable warning component advising verification of BIS information before making compliance decisions.

Command Palette and System Pages

  • As a user, I want a Ctrl+K command palette for quick navigation and a polished 404 page.

Performance and Code Quality

  • As a developer, I want to use the existing framework and organize the frontend into maintainable components with optimized performance.
  • As a developer, I want to implement Auth Context and Theme Context for better state management and theming.
Page 5 of 7

API Rule

  • As a developer, I want to use existing API endpoints exactly as they are without inventing new endpoints.

SIH Demonstration Quality

  • As a user, I want the website to be impressive for a Smart India Hackathon presentation, with a clear user journey through key features.

Testing

  • As a developer, I want to thoroughly test all website functionalities, including responsiveness, dark mode, language UI, voice input, loading states, errors, empty states, source links, and backend connectivity. This includes testing for broken imports, undefined variables, incorrect API paths, broken images, fake API calls, hardcoded secrets, console errors, and runtime errors.

User Personas

  • General User: Individuals seeking to discover and understand Indian Standards and BIS services.
  • Administrator: Users with access to additional administrative functionalities if supported by the backend.

Core User Flows

  1. Home to AI Assistant: User navigates from the homepage to the AI Assistant page to ask questions and receive organized answers.
  2. Standards Search to Details: User searches for standards, views search results, and accesses detailed information on selected standards.
  3. Document Upload and Analysis: User uploads a document for analysis, views the processing workflow, and reviews the analysis results.
  4. Recommendation Process: User accesses the recommendation page, inputs product details, and receives standard recommendations.
  5. BIS Services Access: User navigates to the BIS Services page to explore available services and access detailed service information.
Page 6 of 7

Visuals Colors and Theme

  • Primary Colors: Deep navy/government blue, white, light gray/blue.
  • Accent Colors: Green for success, orange/yellow for warnings, red for errors.
  • Accent Colors: Electric cyan, magenta, green for success, orange/yellow for warnings, red for errors.
  • Fonts: Inter, Plus Jakarta Sans, or similar professional fonts.

Signature Design Concept

  • Professional design with clean spacing, polished cards, subtle shadows, and smooth transitions.

Interaction Model & Motion Direction

  • Motion: Continuous slow orbit and parallax, with light sweeps and data streams enhancing the immersive experience
  • Motion tempo: cinematic; hero dimensionality: webgl (a real-time WebGL/R3F hero subject is part of this direction); hero drama: immersive
  • Imagery: Abstract 3D objects and particle fields, with a focus on holographic and volumetric visuals
  • Hero direction: A full-bleed 3D scene with floating glass panels, electric cyan glows as the dominant element, layered with parallax effects to create depth and movement.
  • Signature moves: Full-bleed hero with floating glass panels over a 3D scene; Electric cyan glows highlighting key elements; Data streams and light sweeps integrated into transitions; Wide geometric sans headings in Space Grotesk; Layered parallax effects for immersive depth
  • Avoid: Flat 2D compositions; Neutral or overly simple designs; Stock photography or clip art; Generic SaaS layouts; Excessive textual content without visual breaks
  • The generic indigo/blue-on-white SaaS template is forbidden for this project.
  • Smooth transitions and hover effects with tasteful animations.

Non-Functional Requirements

  • The website must be responsive, accessible, and performant with optimized code quality.
Page 7 of 7

Tech Stack

  • Use the existing frontend framework (e.g., React + Vite) without unnecessary migrations.
  • Database: PostgreSQL (with alembic migrations)

Assumptions and Constraints

  • The backend is read-only and must not be modified.
  • All frontend functionalities must connect to existing backend APIs without inventing new endpoints.

Glossary

  • BIS: Bureau of Indian Standards
  • AI: Artificial Intelligence
  • API: Application Programming Interface
  • CRUD: Create, Read, Update, Delete
  • JWT: JSON Web Token
  • SIH: Smart India Hackathon

No completed page designs yet.

Completed design pages will appear here when they are ready to preview.

No user flows yet.

The User Flow Agent will generate per-persona navigation diagrams after SRD updates.

No completed page designs yet.

Completed design pages will appear here when they are ready to preview.

No user flows yet.

The User Flow Agent will generate per-persona navigation diagrams after SRD updates.