How cobiwave/simplefolio works
Project type and purpose
• This is a one-page, front-end portfolio template.
• It uses HTML, Sass, Bootstrap, custom JS (ScrollReveal, Tilt.js) and is bundled/served via Parcel.
• There is no backend or database—just a build step that produces static assets, then deployment to a static host (Netlify or GitHub Pages).
File structure
• src/index.html: entry HTML.
• src/index.js: JavaScript entrypoint (initializes animations).
• src/sass/...: styling hierarchy (variables, mixins, components, layout, sections).
• src/assets/: static resources (resume.pdf, images).
• src/data/scrollRevealConfig.js: config for reveal animations.
• src/scripts/: custom JS modules (scrollReveal.js, tiltAnimation.js).
• package.json + .github/workflows/gh-pages.yml: build and CI/CD definitions.
Extract README insights
• Bundler: Parcel (dev server & production build).
• CSS: Sass + Bootstrap v4.3.
• JS libs: ScrollReveal.js, Tilt.js.
• Deployment: Netlify or GitHub Pages via GitHub Actions.
Main components & interactions
a. Developer workstation
• Source code in GitHub repo (.github, src/, config files).
• Local dev: npm start → Parcel dev server → browser.
b. Continuous Integration & Deployment
• GitHub Actions (.github/workflows/gh-pages.yml) triggered on push to main.
• Runs npm run build (Parcel produces /dist).
• Deploys /dist to GitHub Pages or Netlify.
c. Static Hosting
• Netlify or GH Pages serves static files (HTML, CSS, JS, assets).
d. Client (Browser)
• User’s browser requests index.html, downloads CSS & JS bundles, assets.
• Executes JS for reveal & tilt animations.
Architectural patterns & design principles
• “Separation of Concerns”: HTML (structure), Sass (styles), JS (behavior).
• Build Pipeline: Parcel transforms ES6 & Sass → single/minified bundles.
• One-page application with lazy-loaded assets for performance.
Details
• Source folder breakdown:
• How Sass abstracts variables → mixins → components → sections → final CSS
• JS modules loading sequence (scrollRevealConfig → init of ScrollReveal & Tilt)
• Build output: single CSS & JS bundles under /dist
• CI workflow name and trigger (gh-pages.yml)
• Deployment target (URL of Netlify or GitHub Pages)