# pratikshinde99/studyportal_it architecture

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

- Interactive diagram: https://gitdiagram.com/pratikshinde99/studyportal_it
- Repository: https://github.com/pratikshinde99/studyportal_it

## Overview

StudyPortal is a Flask-based SPPU IT study-material portal. Students authenticate, browse semester and subject materials or search across them, then view/download PDFs and manage favorites; administrators authenticate to upload and manage materials, review usage/content analytics, and post notices. The graph separates those domain workflows from Flask startup and persistence. The route excerpts establish several database, GridFS, and template interactions; README statements support documented capabilities whose route implementations were not sampled.

Main entry points: [`backend/app/__init__.py`](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/__init__.py) (App factory), [`backend/app/routes.py`](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py) (PDF delivery), [`main.py`](https://github.com/pratikshinde99/studyportal_it/blob/main/main.py) (Flask entry), [`backend/app/extensions.py`](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/extensions.py) (Mongo extension)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_platform["Application platform"]
  node_entry["Flask entry<br/>[main.py]"]
  node_factory["App factory<br/>[__init__.py]"]
  node_mongo_ext["Mongo extension<br/>[extensions.py]"]
  node_routes["Portal routes<br/>[routes.py]"]
  node_templates["Portal pages"]
  node_mongo_store[("MongoDB Atlas")]
end

subgraph group_student["Student experience"]
  node_student_auth["Student accounts<br/>[routes.py]"]
  node_favorites["Favorites<br/>[routes.py]"]
end

subgraph group_content["Study materials"]
  node_curriculum["Semester browsing<br/>[routes.py]"]
  node_search["Material search<br/>[routes.py]"]
  node_pdf_catalog["PDF catalog<br/>[routes.py]"]
  node_pdf_delivery["PDF delivery<br/>[routes.py]"]
  node_gridfs[("PDF GridFS")]
end

subgraph group_admin["Administration"]
  node_admin_auth["Admin access<br/>[routes.py]"]
  node_uploads["Material management<br/>[routes.py]"]
  node_analytics["Content analytics<br/>[routes.py]"]
  node_notifications["Admin notices<br/>[routes.py]"]
end

node_student_actor(("Student"))
node_admin_actor(("Administrator"))

node_student_actor -->|"opens portal"| node_entry
node_admin_actor -->|"opens portal"| node_entry
node_entry -->|"creates app"| node_factory
node_factory -->|"initializes"| node_mongo_ext
node_factory -->|"registers routes"| node_routes
node_student_actor -->|"signs up or in"| node_student_auth
node_student_auth -->|"reads/writes accounts"| node_mongo_store
node_student_actor -->|"browses semesters"| node_curriculum
node_curriculum -->|"queries materials"| node_mongo_store
node_student_actor -->|"searches materials"| node_search
node_search -->|"queries materials"| node_mongo_store
node_student_actor -->|"browses PDFs"| node_pdf_catalog
node_pdf_catalog -->|"reads catalog"| node_mongo_store
node_student_actor -->|"downloads PDF"| node_pdf_delivery
node_pdf_delivery -->|"updates download count"| node_mongo_store
node_pdf_delivery -->|"reads PDF bytes"| node_gridfs
node_student_actor -->|"manages favorites"| node_favorites
node_favorites -->|"reads/writes favorites"| node_mongo_store
node_admin_actor -->|"authenticates"| node_admin_auth
node_admin_actor -->|"manages materials"| node_uploads
node_uploads -->|"writes catalog"| node_mongo_store
node_uploads -->|"stores or deletes PDFs"| node_gridfs
node_admin_actor -->|"reviews statistics"| node_analytics
node_analytics -->|"counts and ranks files"| node_mongo_store
node_admin_actor -->|"posts notices"| node_notifications
node_notifications -->|"reads/writes notices"| node_mongo_store
node_routes -->|"renders pages"| node_templates

click node_entry "https://github.com/pratikshinde99/studyportal_it/blob/main/main.py"
click node_factory "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/__init__.py"
click node_mongo_ext "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/extensions.py"
click node_routes "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_student_auth "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_curriculum "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_search "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_pdf_catalog "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_pdf_delivery "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_favorites "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_admin_auth "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_uploads "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_analytics "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_notifications "https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py"
click node_templates "https://github.com/pratikshinde99/studyportal_it/tree/main/frontend/templates"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_factory,node_mongo_ext,node_routes,node_templates,node_mongo_store toneBlue
class node_student_auth,node_favorites toneAmber
class node_curriculum,node_search,node_pdf_catalog,node_pdf_delivery,node_gridfs toneMint
class node_admin_auth,node_uploads,node_analytics,node_notifications toneRose
class node_student_actor,node_admin_actor toneIndigo
```

## Components

### Application platform

- [Flask entry](https://github.com/pratikshinde99/studyportal_it/blob/main/main.py): `main.py`
- [App factory](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/__init__.py): `backend/app/__init__.py`
- [Mongo extension](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/extensions.py): `backend/app/extensions.py`
- [Portal routes](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Portal pages](https://github.com/pratikshinde99/studyportal_it/tree/main/frontend/templates): `frontend/templates`
- **MongoDB Atlas**

### Student experience

- [Student accounts](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Favorites](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`

### Study materials

- [Semester browsing](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Material search](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [PDF catalog](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [PDF delivery](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- **PDF GridFS**

### Administration

- [Admin access](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Material management](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Content analytics](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`
- [Admin notices](https://github.com/pratikshinde99/studyportal_it/blob/main/backend/app/routes.py): `backend/app/routes.py`

### Other components

- **Student**
- **Administrator**

## Connections

- Student → Flask entry: opens portal (evidence: `README.md`)
- Administrator → Flask entry: opens portal (evidence: `README.md`)
- Flask entry → App factory: creates app (evidence: `main.py`)
- App factory → Mongo extension: initializes (evidence: `backend/app/__init__.py`)
- App factory → Portal routes: registers routes (evidence: `backend/app/__init__.py`)
- Student → Student accounts: signs up or in (evidence: `backend/app/routes.py`)
- Student accounts → MongoDB Atlas: reads/writes accounts (evidence: `backend/app/routes.py`)
- Student → Semester browsing: browses semesters (evidence: `README.md`)
- Semester browsing → MongoDB Atlas: queries materials (evidence: `backend/app/routes.py`)
- Student → Material search: searches materials (evidence: `README.md`)
- Material search → MongoDB Atlas: queries materials (evidence: `backend/app/routes.py`)
- Student → PDF catalog: browses PDFs (evidence: `README.md`)
- PDF catalog → MongoDB Atlas: reads catalog (evidence: `backend/app/routes.py`)
- Student → PDF delivery: downloads PDF (evidence: `README.md`)
- PDF delivery → MongoDB Atlas: updates download count (evidence: `backend/app/routes.py`)
- PDF delivery → PDF GridFS: reads PDF bytes (evidence: `backend/app/routes.py`)
- Student → Favorites: manages favorites (evidence: `backend/app/routes.py`)
- Favorites → MongoDB Atlas: reads/writes favorites (evidence: `backend/app/routes.py`)
- Administrator → Admin access: authenticates (evidence: `README.md`)
- Administrator → Material management: manages materials (evidence: `README.md`)
- Material management → MongoDB Atlas: writes catalog (evidence: `backend/app/routes.py`)
- Material management → PDF GridFS: stores or deletes PDFs (evidence: `backend/app/routes.py`)
- Administrator → Content analytics: reviews statistics (evidence: `README.md`)
- Content analytics → MongoDB Atlas: counts and ranks files (evidence: `backend/app/routes.py`)
- Administrator → Admin notices: posts notices (evidence: `backend/app/routes.py`)
- Admin notices → MongoDB Atlas: reads/writes notices (evidence: `backend/app/routes.py`)
- Portal routes → Portal pages: renders pages (evidence: `backend/app/routes.py`)
