How mldangelo/personal-site works
Main Components
• Frontend Application: This includes the React application (mainly in the src folder) with various components (Contact, Projects, Resume, Stats, Template, etc.), pages (About, Contact, Index, Projects, Resume, Stats, NotFound), and layouts.
• Data and Content: The folder src/data holds the markdown, JS modules, and configuration used by the application – it drives the display of content for the personal site.
• Static Assets: The public folder (with index.html, images, etc.) and the src/static folder (CSS and SCSS files) which handle the visual styling.
• Build and Deployment Infrastructure: Configuration files like package.json, babel.config.js, GitHub Actions workflows (inside .github/workflows), and Git-related files show the underlying automation and build pipelines.
• Testing and Linting: Files like jest.config.js, .eslintrc.js, and other similar configuration files denote the quality assurance and testing parts of the project.
Relationships and Interactions
• The React frontend interacts internally by composing modular components (e.g., navigation, sidebar, resume sections) and uses React Router (configured via src/data/routes.js) to navigate between pages.
• Data flows from the static content (in src/data) into the React components to dynamically generate page content.
• The build process (triggered by npm scripts and defined in package.json) compiles the React JSX/SCSS into static assets.
• GitHub Actions workflows orchestrate builds, tests, and deployments to GitHub Pages. This pipeline should be depicted as an external process feeding into the static hosting environment.
Important Architectural Patterns and Design Principles
• Component-Based Architecture: The project follows a modular design by separating concerns into components, pages, and layouts.
• JAMstack Principles: The separation of content and design with static exports and automated deployments.
• Continuous Deployment: Use of GitHub Actions for CI/CD pipelines indicates that every push can trigger tests and a deployment flow.
• Separation of Static Assets and Code: Clear file hierarchy that separates CSS, images, and JavaScript code for maintainability.
Relevant Technologies and Frameworks
• React (and create-react-app scaffolding)
• React-Router for client-side routing
• SCSS for styling
• Babel (babel.config.js) for JavaScript transpilation
• GitHub Actions as CI/CD tool for deployment to GitHub Pages
• Node.js (as indicated by package.json and the required node version)
Elements
• Data flow from the Data Layer to UI Components.
• Build process starting from the source code, moving through Babel/Webpack (or the create-react-app build process), resulting in static files.
• Deployment flow triggered by GitHub Actions.
• Another for static assets (CSS, images, HTML).
• Distinct symbol for external or automated processes (build pipelines and deployment workflows).