How trylastsky/bugbusters_vizitcard works
Project Type and Purpose
• This is a single-page application (SPA) written in React + TypeScript.
• It serves as a personal “vizit card”/portfolio site (“Bug Busters”), delivering static content and UI components to the user’s browser.
• There is no custom backend or database—just static assets, JSON files, and frontend code.
File Structure
• Top-level config and build files:
– package.json / package-lock.json (npm dependencies)
– vite.config.ts (dev server & build pipeline)
– tsconfig*.json (TypeScript configuration)
– eslint.config.js (linting)
• Public entry point: index.html
• Source code under src/:
– src/main.tsx → mounts React into index.html
– src/app/App.tsx (+ App.css) → root component
– src/components/… → reusable UI components (NavBar, Footer, PopUpInfoCase, ScrollToTopButton)
– src/pages/MainPage/… → page-level components (AboutUI, Contacts, ProjectsUI, ShowCase, VizitCard) and nested subcomponents
README
• Confirms prerequisites (Node.js, Git)
• Standard npm install + npm run dev workflow—no server-side logic.
A. Main Components
1. Developer Environment
– Node.js & npm
– Vite Dev Server / Build Pipeline
2. Static Hosting / CDN (for production)
3. Browser (Client)
– index.html
– JS bundle (React + TypeScript → JavaScript)
– CSS assets
– JSON data imports
4. React App Modules
– App Shell (App.tsx)
– Layout components (NavBar, Footer, ScrollToTopButton)
– Page container (MainPage)
– Feature components (AboutUI, Contacts, ProjectsUI, ShowCase, VizitCard)
B. Relationships & Data Flow
• Developer runs npm run dev → Vite dev server serves index.html + static assets → Browser fetches and executes.
• Within the browser, React bootstraps at
.
• App.tsx orchestrates Layout (NavBar + MainPage + Footer).
• MainPage imports JSON data (via ES modules) to feed child components (e.g., ProjectsUI reads data.json).
• User interactions (clicks, scroll) propagate through event handlers in component tree (e.g., PopUpInfoCase, ScrollToTopButton).
C. Architectural Patterns & Principles
• Component-based architecture (React)
• Separation of concerns:
– Container/page components vs. presentational UI components
– Static data (JSON) imported at build time
• Build pipeline: Vite handles hot-reload, code splitting, asset bundling
D. Key Technologies & Frameworks
• React 18 + React DOM
• TypeScript
• Vite (dev server and bundler)
• CSS Modules or plain CSS files per component
• npm for dependency management
Final Recommendations
• Be detailed in capturing the component hierarchy—don’t lump all UI under “frontend.”
• Call out the build step (Vite) separately from the runtime.