How isayanpal/gistiq works
Project Type & Purpose
• GistIQ is a full-stack web application designed to allow users to upload PDF files, have them summarized using Gemini AI, and then view/download the summarized version.
• The project splits clearly into two parts: a frontend (React/TypeScript) and a backend (Node.js with Express).
Main Components
a. Client (Frontend)
• Built using React (TypeScript) and styled with Tailwind CSS, using pre-built components from ShadCN UI and animations via Framer Motion.
• Contains directories for assets, components (both custom and UI specific), pages (like Home and Summarize), and utility libraries.
• Responsible for the user interface: rendering the upload form, displaying summary content, and integrating Axios for API calls.
b. Server (Backend)
• Built using Node.js and Express.
• Provides API endpoints that handle PDF uploads and integration with the Gemini AI service (via @google/generative-ai) to perform summarization.
• Acts as the intermediary between the client and external services.
c. External Services & Integrations
• Gemini AI: Used through the @google/generative-ai package to process and summarize PDFs.
• Hosting/Deployment Platforms: Frontend is deployed on Vercel while the backend is hosted on Render.
Architectural Patterns & Design Principles
• A clear separation between client and server to reflect a modern full-stack architecture.
• That the client is modular, with separate directories for pages, UI components, and assets, which aligns with a component-based design (similar to MVC or Flux if considering React patterns).
• For the backend, note the RESTful API design, where each endpoint corresponds to specific functionalities (e.g., file upload, summary generation, file downloading).
• Resiliency, scalability (by suggesting that additional services may be integrated in the future), and ease of maintenance.