# iamamanrajput/booksnest architecture

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

- Interactive diagram: https://gitdiagram.com/iamamanrajput/booksnest
- Repository: https://github.com/iamamanrajput/booksnest

## Overview

##### Project Type and Purpose
- BooksNest is a full-stack Library Management System.
- Purpose: Allow users to browse, borrow, return, review books; allow admins to manage books, users, and view analytics.
- Frontend: React + Redux + TailwindCSS (Vite, React Router, Recharts).
- Backend: Node.js + Express + MongoDB (Mongoose), JWT auth, Nodemailer, Cloudinary, node-cron jobs.

##### File Structure Analysis
- Top-level:
- backend/ – Express API (app.js, controllers, models, routes, services, middlewares, jobs, utils, config, templates)
- frontend/ – React client (src/ with pages, components, layouts, redux, routes, assets)
- Patterns:
- Backend follows MVC: models → controllers → routes → services.
- Cron jobs in backend/jobs for scheduled email reminders.
- Frontend uses component hierarchy under src/components and page-level routers in src/routes.
- Config & Deployment:
- backend/config holds DB, Cloudinary setup.
- ZENV files for backend (env vars) and frontend (VITE_BACKEND_URL).
- Vercel and Vite config present in frontend.

##### README Insights
- Describes key features (auth, book/user management, borrowing queue, reviews, notifications, analytics).
- Technology stack and API endpoints listed.
- Main user and admin routes spelled out.
- Highlights dev setup and environment variables.

##### Main Components
a. User Interface
- Browser / Mobile client running React app.
- React Router determines routes: user portal vs admin portal.
- Redux store for global state.
b. Backend API
- Express server (app.js) exposing RESTful endpoints (/api/v1/auth, /book, /user, etc.).
- Controllers handle HTTP, invoke services.
- Services implement business logic.
- Models (Mongoose) mapping to MongoDB.
c. Database
- MongoDB cluster (collections: users, books, borrowRecords, reviews, notifications, queues).
d. External Services
- Cloudinary for image uploads.
- Nodemailer (SMTP) for sending emails.
- node-cron scheduler triggering reminder jobs.
e. Third-Party Libraries
- JWT for auth.
- Axios for HTTP calls in frontend.
- Recharts for analytics charts.
- TailwindCSS for styling.

##### Relationships and Data Flow
- Backend → MongoDB (CRUD via Mongoose).
- Backend → Cloudinary (image upload/download).
- Backend → Email Service (Nodemailer) for notifications.
- Cron jobs within backend trigger scheduled email flows via mailSender templates.
- Frontend Redux dispatches actions on API responses.

##### Architectural Patterns & Principles
- MVC in backend: clear separation between models, controllers, services.
- Component-based architecture in React: reusable UI components, layouts, pages.
- API layer decoupled from UI, allowing potential mobile clients.
- Single Page App (SPA) with route-based code-splitting.
- Use of middleware for auth (verifyToken) and error handling.
- Scheduled background jobs for notifications.

##### Final Recommendations
- Arrowheads indicate request vs data push (e.g., scheduler pushing emails).
- Iteratively refine: start broad, then zoom into one workflow for clarity.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend (React + Redux)" 
        direction TB
        FE_Main["main.jsx"]:::frontend
        FE_App["App.jsx"]:::frontend
        FE_Store["Redux Store"]:::frontend
        FE_AuthSlice["Auth Slice"]:::frontend
        FE_UsersSlice["Users Slice"]:::frontend
        subgraph "Routes" 
            direction TB
            FE_AdminRoute["AdminRoute.jsx"]:::frontend
            FE_UserRoute["UserRoute.jsx"]:::frontend
            FE_GuestRoute["GuestRoute.jsx"]:::frontend
        end
        subgraph "Layouts"
            direction TB
            FE_AdminLayout["AdminLayout.jsx"]:::frontend
            FE_UserLayout["UserLayout.jsx"]:::frontend
        end
        subgraph "Pages"
            direction TB
            subgraph "Admin Pages"
                direction TB
                FE_AdminSignin["AdminSignin.jsx"]:::frontend
                FE_Dashboard["Dashboard.jsx"]:::frontend
                FE_AdminBooks["AdminBooks.jsx"]:::frontend
                FE_AllUsers["AllUsers.jsx"]:::frontend
                FE_Requests["Requests.jsx"]:::frontend
                FE_AnalyticsPage["Analytics.jsx"]:::frontend
            end
            subgraph "User Pages"
                direction TB
                FE_Signin["Signin.jsx"]:::frontend
                FE_Signup["Signup.jsx"]:::frontend
                FE_Home["HomePage.jsx"]:::frontend
                FE_AllBooks["AllBooks.jsx"]:::frontend
                FE_BookPage["Book.jsx"]:::frontend
                FE_History["MyHistory.jsx"]:::frontend
                FE_Profile["MyProfile.jsx"]:::frontend
            end
        end
        FE_Store --> FE_AuthSlice
        FE_Store --> FE_UsersSlice
        FE_Main --> FE_App
        FE_App --> FE_Store
        FE_App --> FE_AdminRoute
        FE_App --> FE_UserRoute
        FE_App --> FE_GuestRoute
        FE_AdminRoute --> FE_AdminLayout
        FE_UserRoute --> FE_UserLayout
        FE_AdminLayout --> FE_AdminSignin
        FE_AdminLayout --> FE_Dashboard
        FE_AdminLayout --> FE_AdminBooks
        FE_AdminLayout --> FE_AllUsers
        FE_AdminLayout --> FE_Requests
        FE_AdminLayout --> FE_AnalyticsPage
        FE_UserLayout --> FE_Signin
        FE_UserLayout --> FE_Signup
        FE_UserLayout --> FE_Home
        FE_UserLayout --> FE_AllBooks
        FE_UserLayout --> FE_BookPage
        FE_UserLayout --> FE_History
        FE_UserLayout --> FE_Profile
    end

    %% Backend Layer
    subgraph "Backend (Node.js + Express)" 
        direction TB
        BE_App["app.js"]:::backend
        subgraph "Config"
            direction TB
            BE_DBConfig["db.js"]:::backend
            BE_CloudConfig["cloudinary.js"]:::backend
        end
        BE_Middleware["verifyToken.js"]:::backend
        subgraph "Routes"
            direction TB
            BE_AuthRoutes["auth.routes.js"]:::backend
            BE_BookRoutes["book.routes.js"]:::backend
            BE_BorrowRoutes["borrow.routes.js"]:::backend
            BE_UserRoutes["user.routes.js"]:::backend
            BE_AdminRoutes["admin.routes.js"]:::backend
            BE_NotificationRoutes["notification.route.js"]:::backend
            BE_ProfileRoutes["profile.routes.js"]:::backend
            BE_ReviewRoutes["review.routes.js"]:::backend
            BE_AnalyticsRoutes["analytics.routes.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            BE_AuthController["auth.controller.js"]:::backend
            BE_BookController["book.controller.js"]:::backend
            BE_BorrowController["borrow.controller.js"]:::backend
            BE_UserController["user.controller.js"]:::backend
            BE_AdminController["admin.controller.js"]:::backend
            BE_NotificationController["notification.controller.js"]:::backend
            BE_ProfileController["profile.controller.js"]:::backend
            BE_ReviewController["review.controller.js"]:::backend
            BE_AnalyticsController["analytics.controller.js"]:::backend
        end
        subgraph "Services"
            direction TB
            BE_BookService["bookService.js"]:::backend
        end
        subgraph "Models"
            direction TB
            BE_UserModel["user.model.js"]:::backend
            BE_AdminModel["admin.model.js"]:::backend
            BE_BookModel["book.model.js"]:::backend
            BE_BorrowModel["borrowRecord.model.js"]:::backend
            BE_QueueModel["bookQueue.model.js"]:::backend
            BE_ReviewModel["review.model.js"]:::backend
            BE_NotificationModel["notification.model.js"]:::backend
        end
        subgraph "Jobs"
            direction TB
            BE_DueJob["dueReminderJob.js"]:::backend
            BE_OverdueJob["overdueReminderJob.js"]:::backend
        end
        subgraph "Templates"
            direction TB
            BE_AddQueueTemplate["addQueueEmailTemplate.js"]:::backend
            BE_DueTemplate["dueRemainderEmailTemplate.js"]:::backend
            BE_OverdueTemplate["overdueRemainderEmailTemplate.js"]:::backend
            BE_ReturnTemplate["returnBookEmailTemplate.js"]:::backend
            BE_FineTemplate["finealertEmailTemplate.js"]:::backend
            BE_CommonTemplate["commonEmailTemplate.js"]:::backend
        end
        subgraph "Utils"
            direction TB
            BE_MailSender["mailSender.js"]:::backend
            BE_ImageUploader["imageUploader.js"]:::backend
            BE_TimeUtil["time.js"]:::backend
        end

        BE_App --> BE_DBConfig
        BE_App --> BE_CloudConfig
        BE_App --> BE_Middleware
        BE_App --> BE_AuthRoutes
        BE_App --> BE_BookRoutes
        BE_App --> BE_BorrowRoutes
        BE_App --> BE_UserRoutes
        BE_App --> BE_AdminRoutes
        BE_App --> BE_NotificationRoutes
        BE_App --> BE_ProfileRoutes
        BE_App --> BE_ReviewRoutes
        BE_App --> BE_AnalyticsRoutes

        BE_AuthRoutes --> BE_AuthController
        BE_BookRoutes --> BE_BookController
        BE_BorrowRoutes --> BE_BorrowController
        BE_UserRoutes --> BE_UserController
        BE_AdminRoutes --> BE_AdminController
        BE_NotificationRoutes --> BE_NotificationController
        BE_ProfileRoutes --> BE_ProfileController
        BE_ReviewRoutes --> BE_ReviewController
        BE_AnalyticsRoutes --> BE_AnalyticsController

        BE_AuthController --> BE_BookService
        BE_BookController --> BE_BookService
        BE_BorrowController --> BE_BookService
        BE_UserController --> BE_BookService
        BE_AdminController --> BE_BookService
        BE_NotificationController --> BE_MailSender
        BE_ProfileController --> BE_BookService
        BE_ReviewController --> BE_BookService
        BE_AnalyticsController --> BE_BookService

        BE_BookService --> BE_UserModel
        BE_BookService --> BE_BookModel
        BE_BookService --> BE_BorrowModel
        BE_BookService --> BE_QueueModel
        BE_BookService --> BE_ReviewModel
        BE_BookService --> BE_NotificationModel

        BE_MailSender --> BE_AddQueueTemplate
        BE_MailSender --> BE_DueTemplate
        BE_MailSender --> BE_OverdueTemplate
        BE_MailSender --> BE_ReturnTemplate
        BE_MailSender --> BE_FineTemplate
        BE_MailSender --> BE_CommonTemplate

        BE_DueJob --> BE_MailSender
        BE_OverdueJob --> BE_MailSender
    end

    %% Data Layer
    MongoDB[(MongoDB)]:::database

    BE_UserModel --> MongoDB
    BE_AdminModel --> MongoDB
    BE_BookModel --> MongoDB
    BE_BorrowModel --> MongoDB
    BE_QueueModel --> MongoDB
    BE_ReviewModel --> MongoDB
    BE_NotificationModel --> MongoDB

    %% External Services
    Cloudinary([Cloudinary]):::external
    SMTP([SMTP Email Service]):::external

    BE_CloudConfig --> Cloudinary
    BE_MailSender --> SMTP

    %% Client to API
    FE_App -->|"REST API calls"| BE_App

    classDef frontend fill:#D0E8FF,stroke:#0366d6;
    classDef backend fill:#DFFFD0,stroke:#228B22;
    classDef database fill:#FFEFC0,stroke:#DAA520,shape:cylinder;
    classDef external fill:#F0F0F0,stroke:#A9A9A9,shape:cloud;

    %% Click Events
    click FE_Main "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/main.jsx"
    click FE_App "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/App.jsx"
    click FE_Store "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/redux/store.js"
    click FE_AuthSlice "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/redux/slices/authSlice.js"
    click FE_UsersSlice "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/redux/slices/usersSlice.js"
    click FE_AdminRoute "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/routes/AdminRoute.jsx"
    click FE_UserRoute "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/routes/UserRoute.jsx"
    click FE_GuestRoute "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/routes/GuestRoute.jsx"
    click FE_AdminLayout "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/layouts/AdminLayout.jsx"
    click FE_UserLayout "https://github.com/iamamanrajput/booksnest/blob/main/frontend/src/layouts/UserLayout.jsx"
    click BE_App "https://github.com/iamamanrajput/booksnest/blob/main/backend/app.js"
    click BE_DBConfig "https://github.com/iamamanrajput/booksnest/blob/main/backend/config/db.js"
    click BE_CloudConfig "https://github.com/iamamanrajput/booksnest/blob/main/backend/config/cloudinary.js"
    click BE_Middleware "https://github.com/iamamanrajput/booksnest/blob/main/backend/middlewares/verifyToken.js"
```
