# pulkitporwal/snippeter architecture

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

- Interactive diagram: https://gitdiagram.com/pulkitporwal/snippeter
- Repository: https://github.com/pulkitporwal/snippeter

## Overview

##### Project type and purpose
- This is a full-stack, server-rendered web application built with Next.js and TypeScript.
- Primary goal: allow authenticated users to save, browse, edit, delete, and copy code snippets.

##### File structure
- Top-level framework: Next.js (next.config.mjs, src/app directory).
- Frontend UI components in src/GlobalComponents and src/app/** page and component folders.
- API routes under src/app/api (save-user, snippets).
- Data models in src/models (Snippet.ts, User.ts).
- Utility functions in src/utils (database connection, Gemini-based code generation).
- Middleware (src/middleware.ts) and context providers (src/app/context) for global state.
- Static assets in public (fonts, images).

##### Key insights from README
- Uses Clerk for user authentication and management.
- Tailwind CSS for styling (tailwind.config.ts).
- MongoDB via Mongoose (connectToDatabase utility).
- One-click copy functionality, Pinterest-like grid layout.

##### Main components
a. Browser (User Interface)
- React components served by Next.js (pages and client components under src/app)
- Static assets (fonts, style sheets)

b. Next.js Server (Server-Side Rendering + API Layer)
- Page rendering (SSR/SSG in app/page.tsx and nested routes)
- API Routes (serverless functions in src/app/api/*)

c. Authentication Service
- Clerk (handles sign-in, sign-up flows, session tokens)

d. Business Logic & Data Access
- Context Providers (GlobalContext, SnippetContext)
- Utility: generateCodeWithGemini.ts (optional code generation)
- connectToDatabase.ts (establishes MongoDB connection)
- Mongoose Models (User, Snippet)

e. Database
- MongoDB (collections: users, snippets)

##### Relationships and interactions
- Browser ↔ Next.js Pages: user navigates, SSR/CSR fetches UI and initial data.
- Browser ↔ Clerk: on auth pages, Clerk widget handles login/signup, returns JWT/session.
- Next.js API ↔ Clerk: middleware.ts verifies auth token on protected routes.
- Next.js API ↔ MongoDB: API route handlers import models, use connectToDatabase to read/write snippets or user data.
- Browser ↔ Next.js API: CRUD operations for snippets and user profile via fetch calls to /api/snippets and /api/save-user.
- Optionally, Next.js API ↔ Gemini Service: for dynamic code generation feature.

##### Architectural patterns and principles
- 3-Tier Architecture: Presentation (React/Next.js), Application/API (serverless functions), Data (MongoDB).
- Server-side rendering combined with client components.
- Context-based state management for UI.
- Externalized authentication (Clerk) to offload user security.
- Utility-driven modularity (connectToDatabase, generateCodeWithGemini).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Browser
    Browser["Browser (User)"]:::frontend

    %% Next.js Application Container
    subgraph "Next.js Application"
        %% Frontend Pages & Components
        subgraph "Frontend (Pages & Components)"
            Home["Home Page"]:::frontend
            DashboardPage["Dashboard Page"]:::frontend
            FavoritesPage["Favorites Page"]:::frontend
            TrashPage["Trash Page"]:::frontend
            ProfilePage["User Profile Page"]:::frontend
            SignInPage["Sign-In Page"]:::frontend
            SignUpPage["Sign-Up Page"]:::frontend

            Navbar["Navbar"]:::frontend
            Sidebar["Sidebar"]:::frontend
            ContentEditor["Content Editor"]:::frontend
            Loader["Loader"]:::frontend
            ProfileUser["ProfileUser Widget"]:::frontend
            SearchBar["SearchBar Widget"]:::frontend
            SideBarMenuIcon["SideBarMenuIcon Widget"]:::frontend
            UserDataSaver["UserDataSaver"]:::frontend

            ContentArea["Dashboard Content Area"]:::frontend
            LoadingBar["LoadingBar"]:::frontend
            AllCardsSection["AllCardsSection"]:::frontend
            FavoriteSection["FavoriteSection"]:::frontend
            FavoriteCard["FavoriteCard"]:::frontend
            TrashCardSection["TrashCardSection"]:::frontend
            TrashCard["TrashCard"]:::frontend
        end

        %% API Layer
        subgraph "API Layer (Serverless Routes)"
            SaveUserAPI["/api/save-user Function"]:::api
            SnippetsAPI["/api/snippets Function"]:::api
        end

        %% Context Providers
        subgraph "Context Providers"
            GlobalContext["GlobalContext"]:::util
            SnippetContext["SnippetContext"]:::util
        end

        %% Utilities
        subgraph "Utilities"
            DBConn["connectToDatabase"]:::util
            GeminiUtil["generateCodeWithGemini"]:::util
        end

        %% Middleware & Models
        Middleware["Middleware (Clerk Integration)"]:::util
        SnippetModel["Snippet Model"]:::util
        UserModel["User Model"]:::util
    end

    %% External Services and Database
    clerk["Clerk Authentication Service"]:::ext
    geminiService["Gemini Code Generation Service"]:::ext
    mongodb["MongoDB Database"]:::db

    %% Connections
    Browser -->|"navigate"| Home
    Browser -->|"JWT/session"| SignInPage
    Browser -->|"JWT/session"| SignUpPage
    Browser -->|"CRUD requests"| SaveUserAPI
    Browser -->|"CRUD requests"| SnippetsAPI

    Browser <-->|Auth flows| clerk

    SaveUserAPI -->|uses| Middleware
    SnippetsAPI -->|uses| Middleware
    Middleware -->|verifies token| clerk

    SaveUserAPI -->|calls| DBConn
    SnippetsAPI -->|calls| DBConn
    DBConn -->|manages| SnippetModel
    DBConn -->|manages| UserModel
    SnippetModel -->|reads/writes| mongodb
    UserModel -->|reads/writes| mongodb

    SnippetsAPI -->|optional code gen| geminiService
    geminiService -->|via util| GeminiUtil

    Browser -->|loads UI| Navbar
    Browser -->|loads UI| Sidebar
    Browser -->|loads UI| ContentEditor
    Browser -->|loads UI| Loader
    Browser -->|loads UI| ProfileUser
    Browser -->|loads UI| SearchBar
    Browser -->|loads UI| SideBarMenuIcon
    Browser -->|loads UI| UserDataSaver

    DashboardPage --> ContentArea
    ContentArea --> LoadingBar
    ContentArea --> AllCardsSection
    FavoritesPage --> FavoriteSection
    FavoriteSection --> FavoriteCard
    TrashPage --> TrashCardSection
    TrashCardSection --> TrashCard

    %% Click Events for Component Mapping
    click Home "https://github.com/pulkitporwal/snippeter/blob/main/src/app/page.tsx"
    click DashboardPage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/dashboard/page.tsx"
    click FavoritesPage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/favorite/page.tsx"
    click TrashPage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/trash/page.tsx"
    click ProfilePage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/profile/[[...rest]]/page.tsx"
    click SignInPage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/sign-in/[[...sign-in]]/page.tsx"
    click SignUpPage "https://github.com/pulkitporwal/snippeter/blob/main/src/app/sign-up/[[...sign-up]]/page.tsx"
    click Navbar "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/Navbar.tsx"
    click Sidebar "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/Sidebar.tsx"
    click ContentEditor "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/ContentEditor/ContentEditor.jsx"
    click Loader "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/Loader.tsx"
    click ProfileUser "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/TopBar/ProfileUser.tsx"
    click SearchBar "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/TopBar/SearchBar.tsx"
    click SideBarMenuIcon "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/TopBar/SideBarMenuIcon.tsx"
    click UserDataSaver "https://github.com/pulkitporwal/snippeter/blob/main/src/GlobalComponents/UserDataSaver.tsx"
    click ContentArea "https://github.com/pulkitporwal/snippeter/blob/main/src/app/dashboard/Components/ContentArea/ContentArea.tsx"
    click LoadingBar "https://github.com/pulkitporwal/snippeter/blob/main/src/app/dashboard/Components/ContentArea/LoadingBar/LoadingBar.tsx"
    click AllCardsSection "https://github.com/pulkitporwal/snippeter/blob/main/src/app/dashboard/Components/ContentArea/NotesArea/AllCardsSection.tsx"
    click FavoriteSection "https://github.com/pulkitporwal/snippeter/blob/main/src/app/favorite/Components/FavoriteSection.jsx"
    click FavoriteCard "https://github.com/pulkitporwal/snippeter/blob/main/src/app/favorite/Components/FavoriteCard.tsx"
    click TrashCardSection "https://github.com/pulkitporwal/snippeter/blob/main/src/app/trash/Components/TrashCardSection.tsx"
    click TrashCard "https://github.com/pulkitporwal/snippeter/blob/main/src/app/trash/Components/TrashCard.tsx"
    click SaveUserAPI "https://github.com/pulkitporwal/snippeter/blob/main/src/app/api/save-user/route.ts"
    click SnippetsAPI "https://github.com/pulkitporwal/snippeter/blob/main/src/app/api/snippets/route.ts"
    click Middleware "https://github.com/pulkitporwal/snippeter/blob/main/src/middleware.ts"
    click GlobalContext "https://github.com/pulkitporwal/snippeter/blob/main/src/app/context/GlobalContext.tsx"
    click SnippetContext "https://github.com/pulkitporwal/snippeter/blob/main/src/app/context/SnippetContext.tsx"
    click SnippetModel "https://github.com/pulkitporwal/snippeter/blob/main/src/models/Snippet.ts"
    click UserModel "https://github.com/pulkitporwal/snippeter/blob/main/src/models/User.ts"
    click DBConn "https://github.com/pulkitporwal/snippeter/blob/main/src/utils/connectToDatabase.ts"
    click GeminiUtil "https://github.com/pulkitporwal/snippeter/blob/main/src/utils/generateCodeWithGemini.ts"
    click mongodb "https://github.com/pulkitporwal/snippeter/tree/main/public/fonts/Kode_Mono"
    click mongodb "https://github.com/pulkitporwal/snippeter/tree/main/public/fonts/Poppins"

    %% Styles
    classDef frontend fill:#BBDEFB,stroke:#0D47A1,stroke-width:1px
    classDef api fill:#C8E6C9,stroke:#1B5E20,stroke-width:1px
    classDef util fill:#FFF9C4,stroke:#F57F17,stroke-width:1px
    classDef db fill:#FFE0B2,stroke:#E65100,stroke-width:1px
    classDef ext fill:#E0E0E0,stroke:#424242,stroke-width:1px
```
