# amitkrvr/university-library architecture

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

- Interactive diagram: https://gitdiagram.com/amitkrvr/university-library
- Repository: https://github.com/amitkrvr/university-library

## Overview

##### Project type and purpose
- This is a full-stack web application built with Next.js (App Router), intended as a digital library system that lets users browse, borrow, and manage books, and lets administrators approve accounts, manage books, and view borrow records.

##### File structure
- Top-level directories:
- src/app – Next.js routes and layout for both public and admin areas
- src/api – Next.js serverless API routes for authentication, books, users, contact, reminders, uploads, and workflow
- src/components – reusable React components for UI and admin dashboard
- src/database – Drizzle ORM configuration, schema, migrations, seed data, Redis connection
- src/lib – client- and server-side utilities (actions, auth flows, caching, email, ratelimit)
- src/email – email templates for account approval, borrow confirmations, reminders, etc.
- Configuration and infra files:
- drizzle.config.ts & drizzle/…sql – database migration scripts
- next.config.ts, postcss.config.mjs, eslint.config.mjs – build and lint settings
- middleware.ts – Next.js middleware (e.g., auth checks, rate limiting)

##### Key architectural insights from README
- Standard Next.js app, uses next/font, and deploys on Vercel.

##### Main components and interactions
a. Frontend (Next.js App Router)
- Public UI: browse books, search, profile, contact us
- Auth flows: sign-in, sign-up (NextAuth)
- Admin UI: dashboard, account requests, book and user management
b. Backend/API (Next.js Serverless Functions)
- Authentication: NextAuth handlers under /api/auth
- CRUD endpoints: /api/books, /api/books/borrow, /api/user, /api/contact-us, /api/workflow, /api/due-reminder
- Upload auth: imagekit token generation endpoint
c. Database layer
- Relational DB (PostgreSQL or MySQL via Drizzle ORM)
- Migrations in drizzle/ and schema in src/database/schema.ts
- Redis for caching/session/ratelimiting (src/database/redis.ts)
d. External services
- Email service (via SMTP or SendGrid) for OTP, confirmations, reminders
- ImageKit for book cover uploads
- (Optional) Vercel for hosting, CDN for static assets

##### Architectural patterns and design principles
- File-based routing: clear split of public vs. admin under src/app
- API layer as serverless functions co-located with UI routes
- React Query (via src/lib/react-query) for client-side data fetching and caching
- Drizzle ORM for type-safe database access and migrations
- Middleware used for authentication and rate limiting
- Separation of concerns: UI components, domain actions (src/lib/actions), email templates

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend (Next.js App Router)"
        direction TB
        NextAppRouter["Root Layout\n(src/app/layout.tsx)"]:::ui
        PublicUI["Public UI Routes\n(src/app/(root))"]:::ui
        AuthUI["Authentication UI\n(src/app/(auth)/sign-in & sign-up)"]:::ui
        AdminUI["Admin UI Dashboard\n(src/app/admin)"]:::ui
        ReactQuery["React Query Setup\n(Provider & queryClient)"]:::ui
    end

    %% Backend/API Layer
    subgraph "Backend/API (Serverless Functions)"
        direction TB
        AuthAPI["NextAuth API Handlers\n(src/app/api/auth/[...nextauth]/route.ts)"]:::api
        ImageKitAPI["ImageKit Token Endpoint\n(src/app/api/auth/imagekit/route.ts)"]:::api
        BooksListAPI["Books List/Create\n(src/app/api/books/route.ts)"]:::api
        BooksDetailAPI["Book Detail/Update/Delete\n(src/app/api/books/[id]/route.ts)"]:::api
        BooksBorrowAPI["Borrow Book\n(src/app/api/books/borrow/route.ts)"]:::api
        UserAPI["User Endpoint\n(src/app/api/user/[id]/route.ts)"]:::api
        ContactAPI["Contact Us API\n(src/app/api/contact-us/route.ts)"]:::api
        WorkflowAPI["Workflow API\n(src/app/api/workflow/route.ts)"]:::api
        ReminderAPI["Due-Reminder Job\n(src/app/api/due-reminder/route.ts)"]:::api
        UploadAuthAPI["Upload Auth API\n(src/app/api/upload-auth/route.ts)"]:::api
    end

    %% Database Layer
    subgraph "Database Layer"
        direction TB
        DrizzleConfig["drizzle.config.ts"]:::db
        Schema["Schema\n(src/database/schema.ts)"]:::db
        DrizzleClient["Drizzle ORM\n(src/database/drizzle.ts)"]:::db
        Migrations["Migrations\n(drizzle/*.sql)"]:::db
        RedisCache["Redis Cache\n(src/database/redis.ts)"]:::db
    end

    %% External Services
    subgraph "External Services"
        direction TB
        EmailService["SMTP/SendGrid Email Service"]:::ext
        ImageKitService["ImageKit"]:::ext
        VercelHost["Vercel Hosting & CDN"]:::ext
    end

    %% Middleware
    Middleware["Middleware\n(middleware.ts)"]:::api

    %% Utilities & Templates
    subgraph "Utilities & Templates"
        direction TB
        Utils["Client/Server Utilities\n(src/lib)"]:::api
        EmailTemplates["Email Templates\n(src/email/*.tsx)"]:::ext
    end

    %% Interactions
    User["User"]:::external
    User -->|uses| NextAppRouter
    NextAppRouter -->|renders| PublicUI
    NextAppRouter -->|renders| AuthUI
    NextAppRouter -->|renders| AdminUI
    PublicUI -->|fetch via React Query| BooksListAPI
    PublicUI -->|fetch book| BooksDetailAPI
    AuthUI -->|auth via NextAuth| AuthAPI
    AdminUI -->|manage via API| WorkflowAPI
    AdminUI -->|manage books| BooksListAPI
    AdminUI -->|manage users| UserAPI
    ReactQuery -->|provides client| PublicUI
    ReactQuery -->|provides client| AdminUI

    %% API to Database
    AuthAPI -->|"reads/writes"| DrizzleClient
    BooksListAPI -->|CRUD operations| DrizzleClient
    BooksDetailAPI -->|CRUD operations| DrizzleClient
    BooksBorrowAPI -->|writes borrow record| DrizzleClient
    UserAPI -->|reads/writes| DrizzleClient
    WorkflowAPI -->|writes approvals| DrizzleClient
    ReminderAPI -->|reads due records| DrizzleClient
    UploadAuthAPI -->|no DB| DrizzleClient
    %% Caching
    AuthAPI -->|session cache| RedisCache
    BooksListAPI -->|cache| RedisCache

    %% API to External
    AuthAPI -->|sends email| EmailService
    WorkflowAPI -->|send approval| EmailService
    BooksBorrowAPI -->|send confirmation| EmailService
    ReminderAPI -->|send reminder| EmailService
    UploadAuthAPI -->|request token| ImageKitService
    PublicUI -->|upload cover| ImageKitService

    %% Middleware flows
    NextAppRouter -->|next requests| Middleware
    Middleware -->|passes to| AuthAPI
    Middleware -->|passes to| BooksListAPI

    %% Database config and migrations
    DrizzleConfig -->|applies| Migrations
    Schema -->|used by| DrizzleClient

    %% Hosting
    NextAppRouter -->|deployed on| VercelHost
    API -->|deployed on| VercelHost

    %% Click Events
    click NextAppRouter "https://github.com/amitkrvr/university-library/blob/main/src/app/layout.tsx"
    click PublicUI "https://github.com/amitkrvr/university-library/tree/main/src/app/(root)"
    click AuthUI "https://github.com/amitkrvr/university-library/blob/main/src/app/(auth)/sign-in/page.tsx"
    click AuthUI "https://github.com/amitkrvr/university-library/blob/main/src/app/(auth)/sign-up/page.tsx"
    click AdminUI "https://github.com/amitkrvr/university-library/tree/main/src/app/admin"
    click AuthAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/auth/[...nextauth]/route.ts"
    click ImageKitAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/auth/imagekit/route.ts"
    click BooksListAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/books/route.ts"
    click BooksDetailAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/books/[id]/route.ts"
    click BooksBorrowAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/books/borrow/route.ts"
    click UserAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/user/[id]/route.ts"
    click ContactAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/contact-us/route.ts"
    click WorkflowAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/workflow/route.ts"
    click ReminderAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/due-reminder/route.ts"
    click UploadAuthAPI "https://github.com/amitkrvr/university-library/blob/main/src/app/api/upload-auth/route.ts"
    click DrizzleConfig "https://github.com/amitkrvr/university-library/blob/main/drizzle.config.ts"
    click Schema "https://github.com/amitkrvr/university-library/blob/main/src/database/schema.ts"
    click DrizzleClient "https://github.com/amitkrvr/university-library/blob/main/src/database/drizzle.ts"
    click Migrations "https://github.com/amitkrvr/university-library/tree/main/drizzle"
    click RedisCache "https://github.com/amitkrvr/university-library/blob/main/src/database/redis.ts"
    click EmailTemplates "https://github.com/amitkrvr/university-library/tree/main/src/email"
    click ReactQuery "https://github.com/amitkrvr/university-library/blob/main/src/lib/react-query/ReactQueryProvider.tsx"
    click ReactQuery "https://github.com/amitkrvr/university-library/blob/main/src/lib/react-query/queryClient.ts"
    click Utils "https://github.com/amitkrvr/university-library/tree/main/src/lib"
    click Middleware "https://github.com/amitkrvr/university-library/blob/main/middleware.ts"

    %% Styles
    classDef ui fill:#bbdefb,stroke:#1e88e5,color:#0d47a1
    classDef api fill:#c8e6c9,stroke:#388e3c,color:#1b5e20
    classDef db fill:#ffe0b2,stroke:#ef6c00,color:#e65100
    classDef ext fill:#d1c4e9,stroke:#6a1b9a,color:#4a148c
    classDef external fill:#f5f5f5,stroke:#9e9e9e,color:#424242,stroke-dasharray: 5 5
```
