# namanpatel7030/scanx---ai-note-writer-applicataion- architecture

> Architecture diagram of the GitHub repository namanpatel7030/scanx---ai-note-writer-applicataion-, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/namanpatel7030/scanx---ai-note-writer-applicataion-
- Repository: https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-

## Overview

##### Project Type and Purpose
- Full‑stack, server‑rendered React application built with Next.js (App Router).
- Purpose: AI‑powered note writer that lets authenticated users upload PDFs, view/edit them in a workspace, and generate AI‑assisted notes.
- Backed by Convex (real‑time database + serverless functions), integrates with an external AI model (via configs/AIModel.js, likely OpenAI).

##### Main Components
a. Client (Browser) / Frontend
– Next.js pages (scanx/app/…)
- Public pages: /about, /features, /pricing, /solution
- Auth pages: /sign‑in, /sign‑up (App Router dynamic routes)
- Dashboard: /dashboard, /dashboard/upgrade
- Workspace: /workspace/[fileid] with sub‑components (PdfViewer, TextEditor, EditorExtension)
– Shared UI library (scanx/components/components/ui) for buttons, dialogs, inputs, progress, etc.
– Global styles (tailwind & postcss), provider.js, middleware.js for authentication checks.

b. Backend / Serverless
– Next.js API routes (scanx/app/api/pdf‑loader/route.js) for handling file uploads, perhaps returning a fileId.
– Convex functions & schema (scanx/convex/)
- Schema: defines collections (users, notes, pdfStorage, etc.).
- Generated client/server bindings (_generated/...).
- Serverless actions: user.js, notes.js, pdfStorage.js, myAction.js, langchain/db.js – implement core business logic, database queries, AI calls.

c. Database & Real‑Time
– Convex Database (NoSQL document store)
– Real‑time subscriptions for collaborative editing or status updates in the workspace.

d. External AI Service
– AIModel.js config points to whatever external LLM (e.g., OpenAI) is used via LangChain (scanx/convex/langchain/db.js).
– The Convex action functions orchestrate AI calls and post back results to the DB.

e. File Storage
– PDF storage is handled inside Convex (pdfStorage.js) or an external blob store (if implemented).
– Next.js public/ folder for static assets.

##### Relationships & Data Flow
1. User in Browser → Next.js SSR/CSR page load → UI components render.
2. User uploads PDF via UploadPdf component → Next.js API route (/api/pdf‑loader) → Convex function stores PDF and returns fileId.
3. Frontend navigates to /workspace/[fileid] → subscribes to Convex DB for that file’s metadata & notes.
4. User edits text in TextEditor → real‑time updates via Convex client → Convex DB writes.
5. User triggers AI note generation → Frontend calls a Convex action (myAction or LangChain function) → action fetches PDF text, calls external AI (OpenAI), writes result as “note” document.
6. Convex subscriptions push new notes back to the UI → User sees AI‑generated notes in workspace.

##### Architectural Patterns & Design Principles
- Component‑based UI: re‑usable, decoupled UI primitives in components/ui.
- App Router and API Routes: clear separation of serverless endpoints and page logic.
- Real‑time data with Convex: subscription‑based updates mean less manual polling.
- Serverless functions: isolates business logic close to data, scales automatically.
- Single codebase monorepo: frontend, backend, config, and shared utils in one place.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Actors
    A["User"]:::external

    %% Frontend Layer
    subgraph "Frontend (Browser)"
        direction TB
        subgraph "Next.js Pages"
            direction TB
            Home["Home"]:::frontend
            About["About"]:::frontend
            Features["Features"]:::frontend
            Pricing["Pricing"]:::frontend
            Solution["Solution"]:::frontend
            Layout["Root Layout"]:::frontend
        end
        subgraph "Auth Pages"
            direction TB
            SignIn["Sign‑In"]:::frontend
            SignUp["Sign‑Up"]:::frontend
        end
        subgraph "Dashboard"
            direction TB
            DashHome["Dashboard"]:::frontend
            DashLayout["Dashboard Layout"]:::frontend
            Header["Header"]:::frontend
            SideBar["SideBar"]:::frontend
            UploadComp["UploadPdf"]:::frontend
            Upgrade["Upgrade"]:::frontend
        end
        subgraph "Workspace"
            direction TB
            WorkspacePage["Workspace Page"]:::frontend
            PdfViewer["PdfViewer"]:::frontend
            TextEditor["TextEditor"]:::frontend
            Extension["EditorExtension"]:::frontend
            WH["Workspace Header"]:::frontend
        end
        subgraph "UI Library"
            direction TB
            Btn["Button"]:::frontend
            Dialog["Dialog"]:::frontend
            Input["Input"]:::frontend
            InputOtp["Input‑OTP"]:::frontend
            Popover["Popover"]:::frontend
            Progress["Progress"]:::frontend
            Resizable["Resizable"]:::frontend
            Sonner["Sonner"]:::frontend
        end
        Styles["Globals & Config"]:::frontend
        Middleware["Auth Middleware"]:::frontend
    end

    %% Backend Layer
    subgraph "Serverless (Next.js API + Convex)"
        direction TB
        APIRoutes["POST /api/pdf‑loader"]:::backend
        subgraph "Convex Functions"
            direction TB
            UserFn["user.js"]:::backend
            NotesFn["notes.js"]:::backend
            PdfStorageFn["pdfStorage.js"]:::backend
            MyAction["myAction.js"]:::backend
            LangChainDB["langchain/db.js"]:::backend
        end
    end

    %% Data Stores & External
    ConvexDB["Convex Database"]:::datastore
    ExternalAI["External AI Service"]:::external
    Blob["Blob Storage"]:::external

    %% Data Flows
    A -->|"Loads Pages"| Home
    Home -->|"renders via Layout"| Layout
    A -->|"Uploads PDF"| UploadComp
    UploadComp -->|"POST /api/pdf‑loader"| APIRoutes
    APIRoutes -->|"calls pdfStorage.upload()"| PdfStorageFn
    PdfStorageFn -->|"Writes PDF"| ConvexDB
    A -->|"Opens Workspace"| WorkspacePage
    WorkspacePage -->|"subscribe"| ConvexDB
    TextEditor -->|"Real-time update"| ConvexDB
    A -->|"Generate AI Notes"| MyAction
    MyAction -->|"Fetch PDF & call AI"| LangChainDB
    LangChainDB -->|"AI Model API Call"| ExternalAI
    LangChainDB -->|"Writes Note"| ConvexDB
    ConvexDB -->|"Push update"| WorkspacePage

    %% Click Events - Frontend
    click Home "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/page.js"
    click About "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/about/page.js"
    click Features "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/features/page.js"
    click Pricing "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/pricing/page.js"
    click Solution "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/solution/page.js"
    click Layout "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/layout.js"
    click SignIn "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/(Auth)/sign-in/[[...sign-in]]/page.jsx"
    click SignUp "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/(Auth)/sign-up/[[...sign-up]]/page.jsx"
    click DashHome "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/page.js"
    click DashLayout "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/layout.js"
    click Header "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/_components/Header.js"
    click SideBar "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/_components/SideBar.js"
    click UploadComp "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/_components/UploadPdf.js"
    click Upgrade "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/dashboard/upgrade/page.js"
    click WorkspacePage "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/workspace/[fileid]/page.js"
    click PdfViewer "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/workspace/[fileid]/_components/PdfViewer.js"
    click TextEditor "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/workspace/[fileid]/_components/TextEditor.js"
    click Extension "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/workspace/[fileid]/_components/EditiorExtension.js"
    click WH "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/workspace/[fileid]/_components/workspace_header.js"
    click Btn "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/button.jsx"
    click Dialog "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/dialog.jsx"
    click Input "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/input.jsx"
    click InputOtp "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/input-otp.jsx"
    click Popover "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/popover.jsx"
    click Progress "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/progress.jsx"
    click Resizable "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/resizable.jsx"
    click Sonner "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/components/components/ui/sonner.jsx"
    click Styles "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/globals.css"
    click Styles "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/provider.js"
    click Styles "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/tailwind.config.mjs"
    click Styles "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/postcss.config.mjs"
    click Middleware "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/middleware.js"

    %% Click Events - Backend & Data
    click APIRoutes "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/app/api/pdf‑loader/route.js"
    click UserFn "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/user.js"
    click NotesFn "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/notes.js"
    click PdfStorageFn "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/pdfStorage.js"
    click MyAction "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/myAction.js"
    click LangChainDB "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/langchain/db.js"
    click ConvexDB "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/schema.js"
    click ConvexDB "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/_generated/api.js"
    click ConvexDB "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/_generated/server.js"
    click ConvexDB "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/convex/_generated/*.d.ts"
    click ExternalAI "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/blob/main/scanx/configs/AIModel.js"
    click Blob "https://github.com/namanpatel7030/scanx---ai-note-writer-applicataion-/tree/main/scanx/public/"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#006064
    classDef backend fill:#E8F5E9,stroke:#2E7D32,color:#2E7D32
    classDef datastore fill:#FFF3E0,stroke:#EF6C00,color:#EF6C00
    classDef external fill:#ECEFF1,stroke-dasharray:5,stroke:#455A64,color:#455A64
```
