# nishant-tiwari24/company-wise-dsa architecture

> Architecture diagram of the GitHub repository nishant-tiwari24/company-wise-dsa, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nishant-tiwari24/company-wise-dsa
- Repository: https://github.com/nishant-tiwari24/company-wise-dsa

## Overview

##### Project Type and Purpose
- This repository is a static documentation‐style “open-source tool” that aggregates Data Structures & Algorithms (DSA) resources (notes, links, tables).
- It is not a full-stack application: there’s no runtime code or services. Instead, it’s a content hub of Markdown files that can be hosted as a static site or consumed directly.

##### File Structure Analysis
- Top-level files:
- Best-Resume-Projects.md
- README.md
- logic-building.md
- No “src” or “lib” directories, no executable scripts or configuration files.
- All content lives as Markdown, implying a static site generator (e.g., Jekyll, Docusaurus) or direct GitHub Pages hosting.

##### README Insights
- Serves as the landing page with external links to DSA courses, Google Drive collections, and an internship calendar.
- Contains a large table mapping companies to DSA folder links and pattern-solving tricks.
- No build instructions, but the presence of Markdown implies static content publishing.

a. Main Components
- Git Repository (source of truth for Markdown files)
- Content Files (the three MD files plus any future additions)
- Static Site Generator (optional; e.g., Jekyll, Hugo, Docusaurus)
- Continuous Integration/Deployment Pipeline (GitHub Actions or similar)
- Hosting Service (GitHub Pages, Netlify, Vercel)
- Consumers/Users (developers or students accessing via web or clone)
- External Resources (Google Drive, yournishaant.rpy.club, aicteinternship.in)

b. Relationships and Interactions
- Developers commit Markdown → GitHub Repo
- Repo triggers CI pipeline → builds static site via generator
- Built site is deployed to hosting service
- End-users load site in browser → click external links → external services
- Users can also clone repo locally to read/edit files

c. Architectural Patterns and Principles
- “Content-centric” micro-architecture: lazy, file-based storage
- CI/CD for documentation: every commit leads to instant rebuild/deploy
- Externalization of heavy assets: using Google Drive, third-party links
- Extensibility: drop new MD files into repo → auto-published

d. Key Technologies and Frameworks
- Markdown (content format)
- Git/GitHub (version control, hosting)
- (Optional) Static site generator: Jekyll, Hugo, Docusaurus
- CI platform: GitHub Actions, Travis CI, CircleCI
- Hosting: GitHub Pages, Netlify, Vercel

##### Detailed Coverage of Architectural Elements
- That the README is the “homepage” MD, best-resume-projects.md and logic-building.md are secondary pages.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Users
    developer["Developer / Contributor"]:::user
    enduser["End-User"]:::user

    %% Internal Systems
    repo["GitHub Repo\n(source of truth)"]:::internal
    ci["CI/CD Pipeline"]:::internal
    generator["Static Site Generator\n(Jekyll/Hugo/Docusaurus)"]:::internal

    %% Content Storage
    subgraph "Content Files"
        README["README.md"]:::storage
        BestResume["Best-Resume-Projects.md"]:::storage
        LogicBuilding["logic-building.md"]:::storage
    end

    %% Hosting
    hosting["Hosting Service\n(GitHub Pages/Netlify/Vercel)"]:::hosting

    %% External Resources
    subgraph "External Resources"
        drive["Google Drive"]:::external
        yournish["yournishaant.rpy.club"]:::external
        aicte["aicteinternship.in"]:::external
    end

    %% Data Flows
    developer -->|"commit MD files"| repo
    repo --> ci
    ci -->|"build static site"| generator
    generator --> hosting
    hosting --> enduser
    hosting --> drive
    hosting --> yournish
    hosting --> aicte

    %% Content linkage
    repo --> README
    repo --> BestResume
    repo --> LogicBuilding

    %% Click Events
    click repo "https://github.com/nishant-tiwari24/company-wise-dsa/tree/main/./"
    click README "https://github.com/nishant-tiwari24/company-wise-dsa/blob/main/README.md"
    click BestResume "https://github.com/nishant-tiwari24/company-wise-dsa/blob/main/Best-Resume-Projects.md"
    click LogicBuilding "https://github.com/nishant-tiwari24/company-wise-dsa/blob/main/logic-building.md"

    %% Styles
    classDef internal fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef storage fill:#90EE90,stroke:#000,stroke-width:1px,shape:cylinder
    classDef hosting fill:#FFA500,stroke:#000,stroke-width:1px
    classDef user fill:#FFFF00,stroke:#000,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#000,stroke-width:1px
```
