How platypusonmars/portfolio-site works
Project type and purpose
• This is a single-page application (SPA) built with Create React App.
• Its purpose is purely front-end: it serves a React component tree that renders a UI (Banner, NavBar, Skills, ProjectCard, Footer, etc.) in the browser.
File structure
• Top level: package.json & lockfile, public/, src/
• public/: static assets served as-is (index.html, manifest.json, robots.txt, images/fonts under /public or /src/assets).
• src/: React entrypoint (index.js → App.js), CSS, test files, asset folders, component subfolder with presentational components.
• Build and dev config is hidden behind CRA scripts.
Extract insights from the README
• Standard CRA scripts: start (dev server + HMR), test, build (webpack-based bundling + optimization), eject (advanced custom config).
• No backend, no API endpoints—pure static site with JS bundle.
a. Main components
• Developer’s machine (IDE)
• Build pipeline (npm scripts + Webpack + Babel)
• Static asset server / hosting (e.g., NGINX, CDN, GitHub Pages)
• Client browser
• React runtime + Component tree (App → NavBar, Banner, LifeSpanner, Skills, ProjectCard, Footer)
• Asset repositories (images, fonts, CSS)
b. Relationships & interactions
1. Developer writes code in src/ → runs npm start or npm run build.
2. Webpack + Babel transpile & bundle JS/CSS/images → output to build/ folder.
3. CI/CD or manual deploy pushes build/ to hosting/CDN.
4. Browser requests index.html → static server returns index.html + bundle.js + other assets.
5. Browser runs bundle.js → React mounts to
→ renders component tree.
c. Architectural patterns & principles
• SPA pattern: client-side routing (if present) and rendering.
• Component-based design: UI broken into reusable presentation components.
• Asset pipeline: Webpack handles code splitting, tree shaking.
• Dev vs. Prod branching: Hot Module Replacement in dev, optimizations in prod build.
d. Key technologies/frameworks
• React (with react-dom)
• Webpack + Babel under the hood (via CRA)
• npm (or yarn) scripts for build/test/start
• CSS modules (global .css files)
• Optional test runner (Jest + React Testing Library)