How nishant-tiwari24/company-wise-dsa works
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.