How patelnildip/myprofile works
Project type and purpose
• This is a static, personal-profile website (JAMstack architecture) hosted on GitHub Pages.
• It uses Jekyll as the static-site generator, SCSS for styling, third-party CSS/JS libraries, and plain HTML/JS/CSS for the front end.
• The README confirms it’s a GitHub Pages site rebuilt via Jekyll on each push, with content in Markdown and styling via SCSS/Bootstrap.
File structure
• Top-level files and dirs:
• index.html – the entry point for the browser
• README.md & _config.yml – Jekyll config and documentation
• /css, /js, /images, /fonts – static asset folders
• /scss – source styles, including Bootstrap overrides and custom SCSS
• /lib – vendor CSS/JS/frameworks (Animate.css, AOS, Bootstrap, jQuery plugins, etc.)
• prepros-6.config – local SCSS compilation settings
• No backend code or API services—purely static.
• Build step: SCSS → CSS, Jekyll templates/Markdown → HTML, bundling of CSS/JS assets.
README for additional insights
• Project uses GitHub’s Jekyll pipeline.
Components
a. Developer Environment
– Source code repo (GitHub) containing HTML, SCSS, JS, Markdown.
– Local dev tool (Prepros or similar) that compiles SCSS to CSS.
b. CI/CD / Build Pipeline
– GitHub Actions (or GitHub Pages built-in) triggers Jekyll build on push.
– Jekyll engine processes layouts, includes, Markdown → static HTML.
– SCSS compiler (could be a step in Jekyll or external tool) → final CSS files.
c. Hosting
– GitHub Pages serves generated files over HTTPS as a CDN.
d. Browser & External Services
– User’s web browser requests index.html and assets from GitHub Pages.
– Front-end JS interacts with Google Maps API (google-map.js) and any other client-side plugins (AOS, Magnific Popup).
e. Static Assets
– CSS, JS, images, fonts delivered directly from the same origin (GitHub Pages) or via CDN, if configured.
Relationships and interactions
• Developer → pushes code → GitHub Repo.
• GitHub Repo → triggers Jekyll build → generates /_site with HTML/CSS/JS.
• GitHub Pages → serves /_site files → User’s Browser.
• Browser → downloads index.html → pulls in CSS, JS, fonts, images.
• Browser JS → calls external APIs (Google Maps, AOS animations).
Architectural patterns & design principles
• JAMstack (pre-build, CDN-served static content).
• Asset pipeline: SCSS modularization, Bootstrap overrides, vendor libs in /lib.
• Progressive enhancement: no server-side logic, behavior via client-side JS.
• Separation of concerns: content (Markdown), layout (HTML templates), styling (SCSS), behavior (JS).