How gustavogamboa96/sxs-tour works
Project Type and Purpose
• This is a single-page frontend application built with Create React App.
• There is no backend or database in this repo; it delivers static assets (HTML/CSS/JS) that run entirely in the browser.
High-Level File Structure
• public/
• index.html – shell HTML that bootstraps the React app
• manifest.json, robots.txt – PWA and SEO config
• src/
• index.js – app entry point, renders <App/> into the DOM
• App.js (+ App.css) – root React component
• LandingPage.js (+ CSS) – a page component
• VerticalScrollProgressBar.js (+ CSS) – a UI component
• font/ and images/ – static asset folders
• setupTests, reportWebVitals – test & performance hooks
• package.json & package-lock.json – dependencies and npm scripts
Key Technologies
• React (JSX, function components)
• Webpack + Babel (hidden configuration via CRA)
• npm scripts: start (dev server), build (production bundling), test
• CSS files for styling, OTF fonts, static images
Main Components and Relationships
• Developer Machine / CI:
• npm start → webpack-dev-server → serves index.html & in-memory JS bundle
• npm run build → Webpack + Babel → optimized static files in build/
• Hosting Layer (e.g., Nginx, S3+CloudFront, Netlify):
• Serves index.html, CSS, JS, fonts, images to clients
• May include a service worker for PWA caching (CRA feature)
• Client Browser:
• Loads index.html → downloads main.js, main.css ↦ initializes React app
• React app module graph: <App/> → <LandingPage/> & <VerticalScrollProgressBar/>
• Static assets (fonts, images) requested as needed
Architectural Patterns and Design Principles
• Component-based UI architecture (React)
• Single-page application (SPA) routing can be added if needed
• Separation of concerns:
• public/: unprocessed static shell
• src/: source code requiring build step
• Build pipeline abstracts away Webpack config until “eject”