# knchn-1/volunteer-connect-recruit-website architecture

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

- Interactive diagram: https://gitdiagram.com/knchn-1/volunteer-connect-recruit-website
- Repository: https://github.com/knchn-1/volunteer-connect-recruit-website

## Overview

##### Project type and purpose
- This is a full-stack web application (“NGO Volunteer Recruitment Platform”) whose goal is to connect NGOs with volunteers.
- Frontend: React + TypeScript (Vite)
- Backend: Express.js + TypeScript + Drizzle ORM (MongoDB)
- Shared: Type definitions and schema in `shared/schema.ts`

##### File structure
- Top-level folders:
- `client/` – React app
- `server/` – Express API
- `shared/` – cross-cutting schema/typings
- Key client subfolders:
- `src/components/` – UI components (and a subfolder `ui/` with primitives)
- `src/pages/` – route-level pages (landing, auth, dashboards, profiles)
- `src/hooks/`, `src/lib/` – abstractions (auth, toast, protected routes, QueryClient)
- Server side:
- `routes.ts` – all HTTP endpoints
- `auth.ts` – JWT/session logic
- `mongodb.ts` – DB connection via Drizzle ORM
- `storage.ts` – file‐ or asset‐storage logic
- Config & build: Vite (`vite.config.ts`), tailwind, tsconfig, `drizzle.config.ts`.

##### README for additional insights
- Confirms tech stack, high-level features: NGO/volunteer profiles, opportunity posting, dashboards.
- No pre-drawn architecture, so we must derive it.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User
    subgraph "User"
        direction TB
        Browser["Web Browser"]
    end

    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        ViteApp["React Frontend (Vite App)"]:::frontend
        Main["Main Entry (main.tsx)"]:::frontend
        AppComp["Root Component (App.tsx)"]:::frontend
        subgraph "UI Library"
            direction TB
            UIlib["UI Component Library"]:::frontend
        end
        subgraph "Pages"
            direction TB
            Landing["Landing Page"]:::frontend
            AuthPage["Authentication Page"]:::frontend
            NGODetails["NGO Details Page"]:::frontend
            subgraph "Recruiter Dashboard"
                direction TB
                RecDash["Recruiter Dashboard"]:::frontend
                RecOpp["Opportunities"]:::frontend
                RecApps["Applications"]:::frontend
                RecProf["Profile"]:::frontend
                RecSug["Suggestions"]:::frontend
            end
            subgraph "Volunteer Dashboard"
                direction TB
                VolHome["Volunteer Home"]:::frontend
                VolProf["Volunteer Profile"]:::frontend
                VolApps["Volunteer Applications"]:::frontend
            end
        end
        subgraph "Hooks & Lib"
            direction TB
            Hooks["Shared Hooks"]:::frontend
            Lib["Client Utilities/Lib"]:::frontend
        end
    end

    %% Shared Layer
    subgraph "Shared Schema/Types"
        direction TB
        Schema["Shared Schema/Types"]:::shared
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        APIServer["Express API Server"]:::backend
        APIEntry["API Entry Point (index.ts)"]:::backend
        Routes["API Routes (routes.ts)"]:::backend
        AuthMod["Auth Module (auth.ts)"]:::backend
        DBConn["MongoDB Connector (mongodb.ts)"]:::backend
        Storage["Storage Service"]:::backend
    end

    %% Database
    MongoDB[(MongoDB)]:::db

    %% External Services
    subgraph "External Services"
        direction TB
        CloudStorage["Cloud Storage"]:::external
        EmailSvc["Email/SMS Service"]:::external
    end

    %% Connections
    Browser -->|"loads static assets"| ViteApp
    ViteApp -->|"boots"| Main
    Main -->|"renders"| AppComp
    AppComp --> UIlib
    AppComp --> Pages
    AppComp --> Hooks
    AppComp --> Lib
    AppComp -->|"REST/JSON"| APIServer
    UIlib -.->|"import types"| Schema
    Pages -.->|"import types"| Schema
    Hooks -.->|"import types"| Schema
    Lib -.->|"import types"| Schema
    APIServer --> APIEntry
    APIEntry --> Routes
    Routes --> AuthMod
    Routes --> DBConn
    Routes --> Storage
    AuthMod -->|"JWT/session"| Schema
    DBConn --> MongoDB
    Storage --> CloudStorage
    APIServer --> EmailSvc

    Schema -.-> Pages
    Schema -.-> AuthMod

    %% Click Events
    click ViteApp "https://github.com/knchn-1/volunteer-connect-recruit-website/tree/main/client/"
    click Main "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/main.tsx"
    click AppComp "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/App.tsx"
    click UIlib "https://github.com/knchn-1/volunteer-connect-recruit-website/tree/main/client/src/components/ui/"
    click Landing "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/landing-page.tsx"
    click AuthPage "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/auth-page.tsx"
    click NGODetails "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/ngo-details.tsx"
    click RecDash "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/recruiter-dashboard.tsx"
    click RecOpp "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/recruiter-opportunities.tsx"
    click RecApps "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/recruiter-applications.tsx"
    click RecProf "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/recruiter-profile.tsx"
    click RecSug "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/recruiter-suggestions.tsx"
    click VolHome "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/volunteer-home.tsx"
    click VolProf "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/volunteer-profile.tsx"
    click VolApps "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/pages/volunteer-applications.tsx"
    click Hooks "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/hooks/use-auth.tsx"
    click Hooks "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/hooks/use-toast.ts"
    click Hooks "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/hooks/use-mobile.tsx"
    click Lib "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/lib/queryClient.ts"
    click Lib "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/lib/protected-route.tsx"
    click Lib "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/client/src/lib/utils.ts"
    click APIServer "https://github.com/knchn-1/volunteer-connect-recruit-website/tree/main/server/"
    click APIEntry "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/server/index.ts"
    click Routes "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/server/routes.ts"
    click AuthMod "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/server/auth.ts"
    click DBConn "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/server/mongodb.ts"
    click Storage "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/server/storage.ts"
    click Schema "https://github.com/knchn-1/volunteer-connect-recruit-website/blob/main/shared/schema.ts"

    %% Styles
    classDef frontend fill:#e0f7e9,stroke:#2d8f6f,color:#036635;
    classDef backend fill:#e0eaff,stroke:#4a6fa5,color:#1d2f6f;
    classDef db fill:#ffe5cc,stroke:#ff8c00,color:#663c00;
    classDef shared fill:#f0f0f0,stroke:#999999,color:#333333;
    classDef external fill:#f5e0ff,stroke:#9a4d9a,color:#4d1a4d;
```
