# samiksha-bansal1/job-portal architecture

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

- Interactive diagram: https://gitdiagram.com/samiksha-bansal1/job-portal
- Repository: https://github.com/samiksha-bansal1/job-portal

## Overview

##### Project type and purpose
- This is a full-stack MERN (MongoDB, Express.js, React.js, Node.js) job‐portal application.
- Purpose: enable job seekers to browse and apply to listings, and employers to post and manage jobs and applications.

##### File structure
- Top-level “backend” folder:
- src/index.js – Express app entry point
- src/db/db.js – MongoDB connection
- src/controllers/… – MVC controllers (application, company, job, user)
- src/models/… – Mongoose schemas
- src/routes/… – Express routers
- src/middlewares/… – JWT auth, Multer for file uploads
- src/utils/responseHandler.js – uniform response formatting
- Top-level “frontend” folder:
- Vite-powered React SPA (main.jsx, App.jsx)
- src/pages – routed views (Home, FindJobs, Profile)
- src/components – reusable UI (jobs, filters, admin panel, auth, common, ui primitives)
- src/hooks – data‐fetching custom hooks
- src/redux – slices for auth, jobs, companies, applications
- PostCSS/Tailwind + ESLint configured

##### Key insights from README
- Features: authentication, job listings, application tracking, user profiles
- Tech stack reaffirmed: React, Express/Node, MongoDB

a. Main components:
- Client Layer: React SPA (UI components, Redux store, custom hooks)
- API Layer: Express.js REST API (routes → controllers → models)
- Database: MongoDB (Atlas or self-hosted)
- File Storage: local or cloud storage via Multer for resumes/profile images
- (Optional) Authentication/Token service (JWT)
b. Relationships & interactions:
1. User (browser) → React SPA → Redux dispatch/actions → HTTP requests (Axios or fetch)
2. HTTP → Express routes → auth middleware → controllers → Mongoose models → MongoDB
3. For file uploads: client → multipart/form-data → Multer middleware → disk/S3
4. Server → sends JSON responses → React updates store → UI re-renders
c. Architectural patterns/design principles:
- Frontend: component-based UI, unidirectional data flow (React + Redux), custom hooks for data fetching
- Backend: MVC pattern (routes/controllers/models), middleware pipeline for auth & file handling
- RESTful API design with consistent response format via responseHandler
d. Key technologies/libraries:
- Frontend: Vite, React, Redux Toolkit, Tailwind CSS, PostCSS
- Backend: Node.js, Express.js, Mongoose, Multer, JSON Web Tokens
- Database: MongoDB

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client (React SPA)"
        direction TB
        MainRender["main.jsx"]:::frontend
        RootComponent["App.jsx"]:::frontend
        subgraph "Pages" 
            direction TB
            HomePage["Home.jsx"]:::frontend
            FindJobsPage["FindJobs.jsx"]:::frontend
            ProfilePage["Profile.jsx"]:::frontend
        end
        subgraph "UI Components"
            direction TB
            UIPrimitives["ui/"]:::frontend
            AuthComponents["auth/"]:::frontend
            AdminComponents["admin/"]:::frontend
            FilterCard["FilterCard.jsx"]:::frontend
            JobCard["JobCard.jsx"]:::frontend
            CommonComponents["common/"]:::frontend
        end
        subgraph "State Management (Redux)"
            direction TB
            StoreConfig["store.js"]:::frontend
            AuthSlice["authSlice.js"]:::frontend
            JobSlice["jobSlice.jsx"]:::frontend
            CompanySlice["companySlice.js"]:::frontend
            ApplicationSlice["applicationSlice.jsx"]:::frontend
        end
        subgraph "Data-fetching Hooks"
            direction TB
            GetAllJobs["useGetAllJobs.jsx"]:::frontend
            GetAppliedJobs["useGetAppliedJobs.jsx"]:::frontend
            GetCompanies["useGetCompanies.jsx"]:::frontend
            GetCompanyById["useGetCompanyById.jsx"]:::frontend
            GetAdminJobs["useGetAdminJobs.jsx"]:::frontend
        end
        subgraph "Utilities"
            direction TB
            FrontUtils["utils.js"]:::frontend
            Constants["constant.js"]:::frontend
        end
    end

    %% API Layer
    subgraph "API Layer (Express.js)"
        direction TB
        IndexJS["index.js"]:::backend
        DBConn["db.js"]:::backend
        subgraph "Routes"
            direction TB
            AppRoutes["application.routes.js"]:::backend
            CompanyRoutes["company.routes.js"]:::backend
            JobRoutes["job.routes.js"]:::backend
            UserRoutes["user.routes.js"]:::backend
        end
        subgraph "Middlewares"
            direction TB
            AuthMW["isAuthenticate.middleware.js"]:::backend
            MulterMW["multer.middleware.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AppController["application.controller.js"]:::backend
            CompanyController["company.controller.js"]:::backend
            JobController["job.controller.js"]:::backend
            UserController["user.controller.js"]:::backend
        end
        subgraph "Models"
            direction TB
            AppModel["applications.model.js"]:::backend
            CompanyModel["company.model.js"]:::backend
            JobModel["job.model.js"]:::backend
            UserModel["user.model.js"]:::backend
        end
        ResponseHandler["responseHandler.js"]:::backend
    end

    %% Storage Layer
    subgraph "Storage"
        direction TB
        DB["MongoDB"]:::database
        FileStorage["File Storage"]:::external
    end

    %% Data Flows
    MainRender --> RootComponent
    RootComponent --> Pages
    Pages --> UIPrimitives
    Pages --> AuthComponents
    Pages --> AdminComponents
    Pages --> FilterCard
    Pages --> JobCard
    Pages --> CommonComponents
    RootComponent --> StoreConfig
    StoreConfig --> AuthSlice
    StoreConfig --> JobSlice
    StoreConfig --> CompanySlice
    StoreConfig --> ApplicationSlice
    UIPrimitives --> GetAllJobs
    UIPrimitives --> GetAppliedJobs
    UIPrimitives --> GetCompanies
    UIPrimitives --> GetCompanyById
    UIPrimitives --> GetAdminJobs
    GetAllJobs -->|HTTP /api/jobs| AppRoutes
    GetAppliedJobs -->|HTTP /api/applications| AppRoutes
    GetCompanies -->|HTTP /api/companies| CompanyRoutes
    GetCompanyById -->|HTTP /api/companies/:id| CompanyRoutes
    GetAdminJobs -->|HTTP /api/jobs/admin| JobRoutes

    AppRoutes --> AuthMW
    CompanyRoutes --> AuthMW
    JobRoutes --> AuthMW
    UserRoutes --> AuthMW
    AuthMW --> MulterMW
    MulterMW --> AppController
    AppRoutes --> AppController
    CompanyRoutes --> CompanyController
    JobRoutes --> JobController
    UserRoutes --> UserController

    AppController --> AppModel
    CompanyController --> CompanyModel
    JobController --> JobModel
    UserController --> UserModel

    AppModel --> DB
    CompanyModel --> DB
    JobModel --> DB
    UserModel --> DB

    IndexJS --> DBConn
    IndexJS --> ResponseHandler
    IndexJS --> AppRoutes
    IndexJS --> CompanyRoutes
    IndexJS --> JobRoutes
    IndexJS --> UserRoutes

    %% File upload flow
    UIPrimitives -->|multipart/form-data| MulterMW
    MulterMW --> FileStorage

    %% Response back to client
    ResponseHandler -->|JSON| RootComponent

    %% Click Events
    click MainRender "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/main.jsx"
    click RootComponent "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/App.jsx"
    click HomePage "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/pages/Home.jsx"
    click FindJobsPage "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/pages/FindJobs.jsx"
    click ProfilePage "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/pages/Profile.jsx"
    click UIPrimitives "https://github.com/samiksha-bansal1/job-portal/tree/main/frontend/src/components/ui/"
    click AuthComponents "https://github.com/samiksha-bansal1/job-portal/tree/main/frontend/src/components/auth/"
    click AdminComponents "https://github.com/samiksha-bansal1/job-portal/tree/main/frontend/src/components/admin/"
    click FilterCard "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/components/FilterCard.jsx"
    click JobCard "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/components/JobCard.jsx"
    click CommonComponents "https://github.com/samiksha-bansal1/job-portal/tree/main/frontend/src/components/common/"
    click StoreConfig "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/redux/store.js"
    click AuthSlice "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/redux/auth/authSlice.js"
    click JobSlice "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/redux/job/jobSlice.jsx"
    click CompanySlice "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/redux/company/companySlice.js"
    click ApplicationSlice "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/redux/application/applicationSlice.jsx"
    click GetAllJobs "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/hooks/useGetAllJobs.jsx"
    click GetAppliedJobs "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/hooks/useGetAppliedJobs.jsx"
    click GetCompanies "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/hooks/useGetCompanies.jsx"
    click GetCompanyById "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/hooks/useGetCompanyById.jsx"
    click GetAdminJobs "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/hooks/useGetAdminJobs.jsx"
    click FrontUtils "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/lib/utils.js"
    click Constants "https://github.com/samiksha-bansal1/job-portal/blob/main/frontend/src/utils/constant.js"
    click IndexJS "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/index.js"
    click DBConn "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/db/db.js"
    click AppRoutes "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/routes/application.routes.js"
    click CompanyRoutes "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/routes/company.routes.js"
    click JobRoutes "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/routes/job.routes.js"
    click UserRoutes "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/routes/user.routes.js"
    click AppController "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/controllers/application.controller.js"
    click CompanyController "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/controllers/company.controller.js"
    click JobController "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/controllers/job.controller.js"
    click UserController "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/controllers/user.controller.js"
    click AppModel "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/models/applications.model.js"
    click CompanyModel "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/models/company.model.js"
    click JobModel "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/models/job.model.js"
    click UserModel "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/models/user.model.js"
    click AuthMW "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/middlewares/isAuthenticate.middleware.js"
    click MulterMW "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/middlewares/multer.middleware.js"
    click ResponseHandler "https://github.com/samiksha-bansal1/job-portal/blob/main/backend/src/utils/responseHandler.js"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#000
    classDef backend fill:#D0FFD0,stroke:#000
    classDef database fill:#FFE8A1,stroke:#000
    classDef external fill:#FFD0D0,stroke:#000,stroke-dasharray: 5 5
```
