# hitarthdesai/scholar-space-ai architecture

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

- Interactive diagram: https://gitdiagram.com/hitarthdesai/scholar-space-ai
- Repository: https://github.com/hitarthdesai/scholar-space-ai

## Overview

##### Project Type and Purpose
ScholarSpace AI is a **full-stack web application** built using **Next.js**, **React**, and **TypeScript**. The project leverages **Drizzle ORM** for database interactions and integrates various frontend and backend functionalities to provide an interactive and dynamic user experience. The application appears to manage classrooms, assignments, chats, files, and user profiles, likely catering to an educational or collaborative environment enhanced with AI capabilities.

##### File Structure Analysis
- **Top-Level Directories and Files:**
- **Configuration Files:** `.env`, `.eslintrc.*`, `.gitignore`, `next.config.mjs`, `tsconfig.json`, etc., indicating a well-configured development environment.
- **Source Code:** Located under the `src` directory, segregated into `actions`, `app`, `components`, `contexts`, `middlewares`, `schemas`, `server`, and `utils`.
- **Database Configuration:** Files like `drizzle.config.ts`, `dbml.ts`, and `schema.dbml` suggest the use of Drizzle ORM for database schema and migrations.
- **Frontend Styling:** `tailwind.config.ts`, `postcss.config.mjs`, and CSS files indicate the use of Tailwind CSS for styling.

- **Architectural Patterns:**
- **MVC Pattern:** The separation of concerns is evident with distinct folders for components (View), actions (Controller), and server/database (Model).
- **API Routes:** Located under `src/app/api`, following Next.js conventions for API endpoints.
- **Context API:** Usage of React Contexts (`src/contexts`) for state management.
- **Middleware:** Custom middleware functions for authentication and route protection (`src/utils/middleware`).

##### README Insights
The README provides setup instructions but lacks detailed architectural descriptions. However, the presence of environment variables like `DATABASE_URL` and `AUTH_RESEND_KEY` indicates backend services handling database connections and authentication mechanisms.

##### a. Main Components
- **Frontend:**
- **Pages:** Located under `src/app`, including routes like `/chat`, `/classrooms`, `/login`, `/profile`, etc.
- **Components:** Reusable UI components (`src/components`) such as headers, forms, dialogs, and specific modules for assignments, chats, classrooms, files, profiles, and questions.
- **State Management:** React Contexts (`src/contexts`) managing state across the application.

- **Backend:**
- **API Routes:** Defined under `src/app/api`, handling authentication (`/auth`), and other backend operations.
- **Database:** Managed via Drizzle ORM with migration files located in `src/server/db/migrations` and schemas in `src/server/db/schema`.
- **Middleware:** Functions for authentication and route handling (`src/utils/middleware`).

- **Utilities:**
- **Helpers and Services:** Located in `src/utils`, including authentication config, breadcrumbs, chat utilities, classroom utilities, storage services (e.g., S3 operations), and more.

- **Configuration:**
- **Environment and Config Files:** `.env`, `next.config.mjs`, `tailwind.config.ts`, etc., managing environment variables and build configurations.

##### b. Relationships and Interactions
- **Frontend ↔ Backend:**
- **API Communication:** Frontend pages and components interact with backend API routes for data fetching, submissions, and real-time updates.

- **Frontend ↔ Database:**
- **Indirect Interaction:** Through backend API routes, leveraging Drizzle ORM for database operations.

- **Components Interaction:**
- **Hierarchy:** Parent components (e.g., `SiteHeader`, `Classrooms`) utilize child components (e.g., `AssignmentCard`, `ChatMessages`) to build the UI.

- **State Management:**
- **Contexts:** Provide global state (e.g., user authentication status) accessible by various components.

##### c. Architectural Patterns and Design Principles
- **Separation of Concerns:** Clear division between frontend UI, backend logic, and database management.
- **Modularity:** Reusable components and utility functions promote maintainability and scalability.
- **Security:** Middleware for authentication ensures protected routes and data access.
- **Scalability:** Organized folder structure accommodates growing features and functionalities.

##### d. Technologies and Frameworks
- **Frontend:** Next.js, React, TypeScript, Tailwind CSS, PostCSS.
- **Backend:** Next.js API routes, Node.js, TypeScript, Drizzle ORM.
- **Database:** Likely PostgreSQL or a similar relational database managed via Drizzle ORM.
- **Miscellaneous:** ESLint for linting, Prettier for code formatting, GitHub for version control.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph Frontend
        FP["Pages"]:::frontend
        subgraph Components
            ChatComp["Chat Components"]:::frontend
            ClassroomComp["Classroom Components"]:::frontend
            AssignComp["Assignment Components"]:::frontend
            FilesComp["Files Management Components"]:::frontend
            ProfileComp["Profile Management Components"]:::frontend
            UIComp["UI Components"]:::frontend
        end
        SM["State Management"]:::frontend
    end
    subgraph Backend
        APIs["API Routes"]:::backend
        AuthAPI["Auth API Route"]:::backend
        MW["Middleware"]:::backend
    end
    subgraph Database
        DBConf["Database Configuration Files"]:::database
        DBSchema["Schema Definitions"]:::database
        DBMigr["Database Migrations"]:::database
    end
    subgraph Utilities
        AuthUtils["Authentication Utilities"]:::utilities
        Breadcrumbs1["GetBreadcrumbsByPage"]:::utilities
        Breadcrumbs2["Breadcrumb Types"]:::utilities
        ChatUtils["Chat Utilities"]:::utilities
        ClassroomUtils["Classroom Utilities"]:::utilities
        AssignAdd["Add Assignment"]:::utilities
        AssignEdit["Edit Assignment"]:::utilities
        StorageS3["Storage Services (S3)"]:::utilities
    end
    subgraph Configuration
        Env[".env"]:::config
        NextConf["next.config.mjs"]:::config
        TailwindConf["tailwind.config.ts"]:::config
        PostCSSConf["postcss.config.mjs"]:::config
        TSConf["tsconfig.json"]:::config
        ESlintCJS[".eslintrc.cjs"]:::config
        ESlintJSON[".eslintrc.json"]:::config
        GitIgnore[".gitignore"]:::config
        PrettierConf["prettier.config.js"]:::config
    end
    %% Relationships
    FP -->|"calls"| APIs
    ChatComp -->|"calls"| APIs
    ClassroomComp -->|"calls"| APIs
    AssignComp -->|"calls"| APIs
    FilesComp -->|"calls"| APIs
    ProfileComp -->|"calls"| APIs
    UIComp -->|"calls"| APIs
    APIs -->|"uses"| MW
    APIs -->|"interacts with"| DBSchema
    APIs -->|"interacts with"| DBMigr
    DBConf -->|"defines"| DBSchema
    AuthUtils -->|"used by"| FP
    AuthUtils -->|"used by"| Backend
    Breadcrumbs1 -->|"used by"| FP
    Breadcrumbs2 -->|"used by"| FP
    ChatUtils -->|"used by"| FP
    ChatUtils -->|"used by"| Backend
    ClassroomUtils -->|"used by"| FP
    ClassroomUtils -->|"used by"| Backend
    AssignAdd -->|"used by"| Backend
    AssignEdit -->|"used by"| Backend
    StorageS3 -->|"used by"| Backend
    %% Click Events
    click FP "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/app"
    click ChatComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/chat"
    click ClassroomComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/classroom"
    click AssignComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/assignment"
    click FilesComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/files"
    click ProfileComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/profile"
    click UIComp "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/components/ui"
    click SM "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/contexts"
    click APIs "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/app/api"
    click AuthAPI "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/app/api/auth/[...nextauth]/route.ts"
    click MW "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/utils/middleware"
    click DBConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/drizzle.config.ts
dbml.ts
schema.dbml"
    click DBSchema "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/server/db/schema"
    click DBMigr "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/server/db/migrations"
    click AuthUtils "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/utils/auth/config.ts"
    click Breadcrumbs1 "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/utils/breadcrumbs/getBreadcrumbsByPage.ts"
    click Breadcrumbs2 "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/utils/breadcrumbs/types.ts"
    click ChatUtils "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/utils/chat"
    click ClassroomUtils "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/utils/classroom"
    click AssignAdd "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/actions/addAssignment.ts"
    click AssignEdit "https://github.com/hitarthdesai/scholar-space-ai/blob/main/src/actions/editAssignment.ts"
    click StorageS3 "https://github.com/hitarthdesai/scholar-space-ai/tree/main/src/utils/storage/s3"
    click Env "https://github.com/hitarthdesai/scholar-space-ai/blob/main/.env"
    click NextConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/next.config.mjs"
    click TailwindConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/tailwind.config.ts"
    click PostCSSConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/postcss.config.mjs"
    click TSConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/tsconfig.json"
    click ESlintCJS "https://github.com/hitarthdesai/scholar-space-ai/blob/main/.eslintrc.cjs"
    click ESlintJSON "https://github.com/hitarthdesai/scholar-space-ai/blob/main/.eslintrc.json"
    click GitIgnore "https://github.com/hitarthdesai/scholar-space-ai/blob/main/.gitignore"
    click PrettierConf "https://github.com/hitarthdesai/scholar-space-ai/blob/main/prettier.config.js"
    %% Styles
    classDef frontend fill:#f9f,stroke:#333,stroke-width:2px
    classDef backend fill:#bbf,stroke:#333,stroke-width:2px
    classDef database fill:#fbf,stroke:#333,stroke-width:2px
    classDef utilities fill:#bfb,stroke:#333,stroke-width:2px
    classDef config fill:#ff9,stroke:#333,stroke-width:2px
```
