How viditagrawal56/metricly_hackathon works
Project Type and Purpose
• Project Type: Full-stack analytics application.
• Purpose: To provide intelligent insights and graphical visualizations of social media data via a responsive UI, while leveraging AI (Generative AI, Groq LLM) and a serverless database (Astra DB) for dynamic analysis.
File Structure
• The project is divided into a frontend (located in the “src” directory) and a backend (the “backend” directory).
• The frontend uses React, TypeScript, and modern UI libraries (Framer Motion for animations, react-chartjs-2/chart.js for graphs, etc.) and contains many UI components (Navbar, Hero, Features, Chat, etc.).
• The backend, built with Node/Express and written in TypeScript, is purpose-built for API operations, possibly handling WebSocket connections, data fetching, and interfacing with external services (e.g., Langflow and the serverless database).
• Additional configuration files (Vite, tsconfig, vercel.json) indicate modern tooling and deployment practices.
README for Additional Insights
• The README highlights key technical features like Intelligent Insights using Generative AI, Graphical Visualization, and a serverless database.
• It explicitly mentions integration with “Langflow” for vectorizing data and interacting with Groq LLM, indicating external AI-driven processing components.
• The README spells out a clear component overview (Navbar, Features, Pricing, Chat, etc.) suggesting a heavily componentized UI.
• The presence of separate links for the live demo and backend suggests distinct, interacting services.
a. Main Components to Include:
• Frontend (React UI):
• UI Components (Navbar, Hero, Features, Chat, Pricing, Team, Footer, etc.)
• Routing/Page Components (Home, Analytics, Chat)
• Animation & Visualization Modules (Framer Motion, chart libraries, etc.)
• Backend (Express Server):
• API Endpoints for handling application logic, including chat and analytics data
• WebSocket connection layer for real-time communications
• Integration with AI services (Langflow & Groq LLM)
• Database Layer:
• Serverless database (Astra DB) for storing social media and user data
• External Services:
• Langflow integration (for dataset vectorizing and loading, feeding input to Groq LLM)
• Generative AI services
b. Relationships and Interactions:
• The Frontend sends HTTP (or WebSocket) requests to the Backend.
• The Backend processes these requests, retrieves data from the Serverless Database, and may invoke AI services (through Langflow) for data insights.
• Data flows back to the Frontend, where visualization components (e.g., charts and graphs) display the results.
c. Architectural Patterns & Design Principles:
• Separation of Concerns: Distinct boundaries between the presentation layer (React UI), business logic (backend APIs/WS), and data management (Astra DB).
• Componentization: Frontend is composed of multiple reusable UI components.
• Real-Time Data Flow: WebSocket connections in the backend for live chat and dynamic updates.
• Modern Deployment: Use of Vite for frontend bundling and serverless database architecture for scalability.
d. Technologies, Frameworks, and External Tools:
• Frontend: React.js, TypeScript, Vite, Framer Motion, chart.js/react-chartjs-2, CSS3 (with modern effects like glassmorphism)
• Backend: Node.js, Express, TypeScript, Websocket
• External: Astra DB (serverless database), Langflow, Groq LLM for AI processing