# saumy1905/pyqfort architecture

> Architecture diagram of the GitHub repository saumy1905/pyqfort, 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/saumy1905/pyqfort
- Repository: https://github.com/saumy1905/pyqfort

## Overview

##### Project type and purpose
- This is an **open-source repository** (PYQFort) that provides a **centralized collection** of PDF question papers (PYQs) for various B.Tech. courses.
- It relies purely on **static file storage** in a GitHub repository and uses standard Git/GitHub workflows for contribution and distribution.

##### File structure
- The top-level folders ( “01. 1st & 2nd Sem…”, “02. Computer Engineering”, “03. IT”, …) correspond to **branches/majors** and **semesters**, each containing subject directories and PDF files.
- There are no code modules, build scripts, or runtime components—just hierarchical content.
- The presence of `README.md` at the root describes usage and contribution flow. No CI/CD or dynamic back end is defined.

##### README for additional insights
- It documents two primary use cases:
a. **End users** browsing/downloading PYQs via mobile or desktop GitHub UI.
b. **Contributors** forking, branching, adding new files, and issuing pull requests.
- It mentions nothing about servers, databases, or automated pipelines—purely Git/GitHub-based.

a. Main components
- **GitHub Repository (Central Storage)**: Hosts the entire directory tree of PDFs and metadata (`README.md`).
- **Contributors**: Fork–clone–branch–commit–push–pull-request workflow.
- **Review/Maintainers**: Merge pull requests into `main`.
- **End Users**:
- Viewing/downloading via GitHub web UI or mobile browser.
- Cloning repository locally to access offline.
- **External Services**: Optional analytics or sponsor banner (GitAds in readme).

b. Relationships and interactions
- (Optional) **GitAds** integration reading `README.md` for ad placement.

c. Architectural patterns / design principles
- **Content repository pattern**: Static content + version control.
- **Fork-and-PR collaboration**: Standard open-source contribution model.
- **File-based hierarchy**: No database, all metadata implied from directory naming.

d. Key technologies / frameworks
- **Git** (distributed version control)
- **GitHub** (hosting, pull-request workflow, static content delivery)
- **Markdown** for documentation (`README.md`)
- **PDF** as content format

##### Detail
- Both **read** paths (user downloads) and **write** paths (contributor commits).
- **external endpoints** (raw file URLs, sponsor ad endpoints).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Entities
    Contributors["Contributors\n(CLI/IDE)"]:::entity
    Maintainers["Maintainers\n(Review & Merge)"]:::entity
    EndUsers["End Users\n(Desktop/Mobile)"]:::entity

    %% Services
    GHWebUI["GitHub Web UI"]:::service
    GitClone["Git Clone\n(Client)"]:::service
    GitAds["GitAds\n(Sponsor Banners)"]:::service

    %% Data Store
    subgraph "GitHub Repository (Central Storage)" 
        direction TB
        GitHubRepo["Repository\n(contents + metadata)"]:::datastore
        README["README.md"]:::datastore
        GoogleDriveLinks["Google Drive Links.txt"]:::datastore
        Sem01["01. 1st & 2nd Sem\n(freshers)"]:::datastore
        CompEng["02. Computer Engineering"]:::datastore
        IT["03. IT"]:::datastore
        Mech["04. Mechanical Engineering"]:::datastore
        ECE["05. ECE"]:::datastore
        ENC["06. ENC"]:::datastore
        EEE["07. Electrical & Electronics Engineering"]:::datastore
        RAI["08. RAI"]:::datastore
        CEH["09. CE (H)"]:::datastore
        BBA["10. BBA"]:::datastore
    end

    %% Contribution Workflow
    Contributors -->|fork| ForkedRepo["Forked Repo"]:::service
    ForkedRepo -->|clone| Contributors
    Contributors -->|branch\n& add files| ForkedRepo
    Contributors -->|commit\n& push| ForkedRepo
    ForkedRepo -->|pull request| Maintainers
    Maintainers -->|merge into main| GitHubRepo

    %% User Access Paths
    EndUsers -->|browse/download| GHWebUI
    GHWebUI --> GitHubRepo
    EndUsers -->|git clone| GitClone
    GitClone --> GitHubRepo

    %% External Services
    GitAds --> README

    %% Click events for components
    click GitHubRepo "https://github.com/saumy1905/pyqfort/tree/main/./"
    click README "https://github.com/saumy1905/pyqfort/blob/main/./README.md"
    click GoogleDriveLinks "https://github.com/saumy1905/pyqfort/blob/main/./Google Drive Links.txt"
    click Sem01 "https://github.com/saumy1905/pyqfort/tree/main/01. 1st & 2nd Sem (for freshers)/"
    click CompEng "https://github.com/saumy1905/pyqfort/tree/main/02. Computer Engineering/"
    click IT "https://github.com/saumy1905/pyqfort/tree/main/03. IT/"
    click Mech "https://github.com/saumy1905/pyqfort/tree/main/04. Mechanical Engineering/"
    click ECE "https://github.com/saumy1905/pyqfort/tree/main/05. ECE/"
    click ENC "https://github.com/saumy1905/pyqfort/tree/main/06. ENC/"
    click EEE "https://github.com/saumy1905/pyqfort/tree/main/07. Electrical & Electronics Engineering/"
    click RAI "https://github.com/saumy1905/pyqfort/tree/main/08. RAI/"
    click CEH "https://github.com/saumy1905/pyqfort/tree/main/09. CE (H)/"
    click BBA "https://github.com/saumy1905/pyqfort/tree/main/10. BBA/"

    %% Styles
    classDef entity fill:#f9d,stroke:#333,stroke-width:1px
    classDef service fill:#ddf,stroke:#333,stroke-width:1px
    classDef datastore fill:#dfd,stroke:#333,stroke-width:1px
```
